Skip to content

uefi: Minor cleanups in the fs module doc #753

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Apr 3, 2023
Merged

uefi: Minor cleanups in the fs module doc #753

merged 1 commit into from
Apr 3, 2023

Conversation

@nicholasbishop
Copy link
Member

@nicholasbishop nicholasbishop commented Apr 3, 2023

  • Typo fix
  • Dropped "This may change in the future but is currently sufficient", I think it's usually clearer to stick to how things currently are in the docs, we can update the doc in the future if we actually change the API.
  • Moved some things out of separate headers, the rustdoc style for h1/h2/h3 is so similar it's hard to even see stuff is semantically nested anyway.

Checklist

  • Sensible git history (for example, squash "typo" or "fix" commits). See the Rewriting History guide for help.
  • Update the changelog (if necessary)
@nicholasbishop
uefi: Minor cleanups in the fs module doc
238e20b 
* Typo fix * Dropped "This may change in the future but is currently sufficient", I think it's usually clearer to stick to how things currently are in the docs, we can update the doc in the future if we actually change the API. * Moved some things out of separate headers, the rustdoc style for h1/h2/h3 is so similar it's hard to even see stuff is nested anyway.
@phip1611 phip1611 merged commit 451d52b into rust-osdev:main Apr 3, 2023
@nicholasbishop nicholasbishop deleted the bishop-fs-doc-tweaks branch April 3, 2023 16:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants

@nicholasbishop @phip1611