FLAML icon indicating copy to clipboard operation
FLAML copied to clipboard

precommit: introduce `mdformat`

Open Borda opened this issue 1 year ago • 3 comments

Why are these changes needed?

This is systematic solution to MD formatting as reported

Related issue number

for example, in #834

Checks

  • [ ] I've included any doc changes needed for https://microsoft.github.io/FLAML/. See https://microsoft.github.io/FLAML/docs/Contribute#documentation to build and test documentation locally.
  • [ ] I've added tests (if relevant) corresponding to the changes introduced in this PR.
  • [ ] I've made sure all auto checks have passed.

Borda avatar Feb 08 '24 13:02 Borda

the core change is 14fdf69, and the resulted formatting is in ac6f076

most of the changes are switch list syntax from * ... to - ...

Borda avatar Feb 08 '24 13:02 Borda

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (550d1cf) 71.61% compared to head (a79e90a) 71.65%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1276      +/-   ##
==========================================
+ Coverage   71.61%   71.65%   +0.04%     
==========================================
  Files          83       83              
  Lines       11249    11249              
  Branches     2360     2360              
==========================================
+ Hits         8056     8061       +5     
+ Misses       2737     2734       -3     
+ Partials      456      454       -2     
Flag Coverage Δ
unittests 71.53% <ø> (+0.04%) :arrow_up:

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov-commenter avatar Feb 08 '24 14:02 codecov-commenter

@sonichi @thinkall, mind check and share your opinion? :rabbit:

Borda avatar Feb 09 '24 14:02 Borda

@sonichi @thinkall @jackgerrits, how are you doing? could you have a quick look? :flamingo:

Borda avatar Feb 28 '24 14:02 Borda

@sonichi @jackgerrits, could you pls also have a look? :rabbit:

Borda avatar Mar 19 '24 18:03 Borda