Skip to content

doc: streamline Error and Argument sections #1603

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc: streamline Error and Argument sections #1603

wants to merge 1 commit into from

Conversation

phip1611
Copy link
Member

@phip1611 phip1611 commented Apr 5, 2025

Streamline all # Errors and # Arguments sections. This is about
the style, not the content. The advantage of this streamlined and
consistent style, is that new contributions can follow the guideline.

This however is only a partial solution, in case we ever want to have a
100% streamlined documentation across the whole crate.

No major changes have been made with a few small exceptions, where I
deleted obviously wrong or irrelevant error codes.

Checklist

  • Sensible git history (for example, squash "typo" or "fix" commits). See the Rewriting History guide for help.
  • Update the changelog (if necessary)

Streamline all `# Errors` and `# Arguments` sections. This is about
the style, not the content. The advantage of this streamlined and
consistent style, is that new contributions can follow the guideline.

This however is only a partial solution, in case we ever want to have a
100% streamlined documentation across the whole crate.

No major changes have been made with a few small exceptions, where I
deleted obviously wrong or irrelevant error codes.
@phip1611 phip1611 changed the title doc: streamline doc: streamline Error and Argument sections Apr 6, 2025
@phip1611 phip1611 mentioned this pull request Apr 6, 2025
13 tasks
@phip1611 phip1611 self-assigned this Apr 7, 2025
@nicholasbishop
Copy link
Member

Some quick notes:

  1. Looks like the blank line after a doc section (e.g. after /// # Examples) has been deleted. I don't know if it's documented as recommended anywhere, but most Rust code I see puts a blank line there, so I'd prefer to keep it.
  2. +1 to consistently using Arguments instead of the mix of Arguments/Parameters, and to consistently using # section instead of # section:, and to using Status::* instead of uefi::Status::*.
  3. I don't have a strong opinion on what the best formatting of error lists is, but if we're using sentence form rather than a colon, lets standardize on using "if" as the connecting word (currently there's a mix of "if" and "when").
  4. This would also be good to break into smaller PRs, e.g. one for any substantive changes ("deleted obviously wrong or irrelevant error codes"), one for uefi::Status -> Status, etc.

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.

2 participants