Add rustdos and intra-doc links to media.rs #144
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
46 tasks
|
@microsoft-github-policy-service agree company="Microsoft" |
dongsupark
reviewed
Nov 14, 2024
John15321
changed the title
dongsupark
reviewed
Nov 19, 2024
| //! - [`mount_parse_ovf_env`]: A function to mount a media device, read its OVF environment data, and return the parsed data. | ||
| //! - [`get_mount_device`]: A function to retrieve a list of mounted devices with CDROM-type filesystems. | ||
| //! | ||
| //! [`Media`]: struct.Media.html |
There was a problem hiding this comment.
For the OVF link above
[`OVF`]: https://www.dmtf.org/standards/ovf
dongsupark
approved these changes
Nov 19, 2024
There was a problem hiding this comment.
Thanks.
One minor note:
In general it is better to start working on your local branch, not with main, but with a different name. That makes reviewers easier to check out your changes to their local repos, for their own testing. If you create a PR from main, then reviewers would need to do something like git checkout -B john15321-rustdocs john15321/main to check out, which is confusing.
Co-authored-by: Dongsu Park <dongsu@mailbox.org>
peytonr18
pushed a commit
that referenced
this pull request
Nov 21, 2024
* Add rustdocs to basic structs * add rustdoc for get_mount_devices * Add rustdocs for parse_ovf_env and read_ovf_env_to_string * Add some more rustdocs and tests * Fixes * Add module level rustdoc * Update libazureinit/src/media.rs * Add more links Co-authored-by: Dongsu Park <dpark@linux.microsoft.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds comprehensive Rustdoc comments to the
media.rsmodule, including descriptions and examples for all structs, functions, and constants. It also introduces intra-doc links for easier navigation. The module-level documentation has been enhanced to provide a clear overview and usage examples. Due to the current lack of mocking, some functions remain testless, but this will be addressed in a later PR.