Skip to content

Doc formating#480

Open
pv42 wants to merge 2 commits intomavlink:masterfrom
pv42:doc_lints
Open

Doc formating#480
pv42 wants to merge 2 commits intomavlink:masterfrom
pv42:doc_lints

Conversation

@pv42
Copy link
Contributor

@pv42 pv42 commented Mar 25, 2026

Some doc improvements mostly based on the 2 lints bellow. Additionally the parser::generate() function doc had references to things that do not apply anymore (message conversion between dialects, protobuf (?)). There are no functional changes.

clippy::doc_link_code

  • merge code fragments that were next to each other using <code> instead of multiple ``
  • enable lint

clippy::doc_paragraphs_missing_punctuation

  • apply lint for all functions, but skip over fields, structs, etc. unless the doc was already a sentence
  • adjusted comment for function to build proper sentences (when required)
  • don't enble the lint since it triggers in cases where punctuation would not make sence e.g. struct fields like system_id

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant