Improve documentation with fixes, comments, and examples#636
Merged
Serial-ATA merged 1 commit intoSerial-ATA:mainfrom Apr 12, 2026
Merged
Improve documentation with fixes, comments, and examples#636Serial-ATA merged 1 commit intoSerial-ATA:mainfrom
Serial-ATA merged 1 commit intoSerial-ATA:mainfrom
Conversation
Serial-ATA
force-pushed
the
docs/improve-documentation
branch
from
6a61696 to
9747266
Compare
Co-authored-by: Serial <69764315+serial-ata@users.noreply.github.com>
Serial-ATA
force-pushed
the
docs/improve-documentation
branch
from
9747266 to
3a3a829
Compare
Owner
|
Thanks! Did a bit of cleanup and added some links |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Typos & stale references:
Fixed grammar in doc/ISSUES.md and doc/PULL_REQUESTS.md
Fixed broken file path references in doc/NEW_FILE.md and doc/NEW_TAG.md (6 stale ../src/ paths → ../lofty/src/)
Fixed code example bugs in doc/NEW_TAG.md (missing &mut self, wrong return type)
Updated fuzz example imports in doc/NEW_FILE.md
Fixed typo in lofty/src/tag/item.rs
Removed ALL #[allow(missing_docs)] (previously 15+ files):
Added doc comments to ~200 items across: FileType, MpegVersion, Layer, ChannelMode, Emphasis, WavFormat, PictureType, Mp4Codec, AudioObjectType, ChannelType, EventType, SyncTextContentType, FrameHeader, TimestampFrame, Timestamp, ReplayGain, EncoderInfo, SplitTagRemainder, ItemKey (~88 variants), ChannelMask (18 constants)
Examples:
Added doc-tested examples to Timestamp and TagItem structs
Module docs:
Added/improved //! module docs for ape/tag, id3/v2/tag, iff, id3