Re: [PR] We have now the CI ensure all doc strings remain formatted [datafusion]

["CuteChuanChuan (via GitHub)" <gi...@apache.org>]

CuteChuanChuan commented on PR #16916:
URL: https://github.com/apache/datafusion/pull/16916#issuecomment-3506018859

   Hi @alamb ,
   
   When working on enabling CI check to ensure consistent formatting, I found there is a conflict. The result of `cargo fmt` cannot pass this command `cargo +nightly fmt --all -- --check --config format_code_in_doc_comments=true`.
   After running `cargo +nightly fmt --all -- --config format_code_in_doc_comments=true`, the result will not pass `cargo fmt --all -- --check`.
   
   It seems that these two actions have different rules about trailing spaces after `//!` and `///`.
   
   How to reproduce
   1. cargo fmt --all → passes
   2. cargo +nightly fmt --all -- --check --config format_code_in_doc_comments=true → fails
   3. cargo +nightly fmt --all -- --config format_code_in_doc_comments=true → fixes it
   4. cargo fmt --all -- --check → fails again
   This creates a loop where developers can't satisfy both checks.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org