MarlinFirmware / Marlin

Marlin is an optimized firmware for RepRap 3D printers based on the Arduino platform. Many commercial 3D printers come with Marlin installed. Check with your vendor if you need source code for your specific machine.
https://marlinfw.org
GNU General Public License v3.0
15.94k stars 19.08k forks source link

📝Update comments/spacing in bedleveling/probe - gcode + other files #27027

Closed classicrocker883 closed 2 weeks ago

classicrocker883 commented 2 weeks ago

Description

Most changes are to feature/bedlevel/, gcode/bedlevel/, gcode/probe/, and module/

Update comments, including but not limited to:

A couple files had some outliers that needed fixed, like **/ instead of */

Requirements

Benefits

Improves readability, Updates descriptions/details/usage of the gcodes while adding doxygen commands.

Configurations

Related Issues

sjasonsmith commented 2 weeks ago

@classicrocker883 why are you continuing to make all these minor cosmetic PRs? Are these impeding your ability to do things with Marlin?

Even if they might be more correct than what is there now, they aren't worth the effort it takes to review them unless there is explicit value being added to justify the time.

classicrocker883 commented 2 weeks ago

sorry it's not actual changes to actual useful code. updates like this have to happen at some point. I mean we are professional over here right? not sloppy and half-assed thrown together.

theres no need to be sarcastic, but these changes will help - because some comments regarding Gcode need updating, like some are missing parameters from documentation. it's good to stay up to date and consistent with the rest of Marlin.

for instance, this comment block makes no sense:

// ideally activating planner.leveling_active (G29 A)
//  should refuse if any invalid mesh points
//  in order to avoid isnan tests per cell,
//  thus guessing zero for undefined points

so yes, actually it does impede one's ability to use Marlin to answer your question. 1000 lines of code to look through may sound like a lot, but if you're like me with photographic memory, over 9000 IQ, I can see everything all at once, so it takes no time at all 🤷‍♂️

sjasonsmith commented 2 weeks ago

I'm sure there were some valuable changes in the middle of those 1000 lines, but you can't expect a maintainer to want to sift through all the noise.

If a change is important, submit a batch of those particular changes as a single PR. Don't mix it with 900 other low-value lines.