Update rustdoc - #62
Conversation
Bloomca
left a comment
Bloomca
left a comment
There was a problem hiding this comment.
Posted by Llŷr
This PR reworks the crate's rustdoc — adding # Errors sections and clarifying TOC, track, retry and read-option semantics — and drops the inherent CdReader::create_wav in favour of the free function. Doc claims match the implementation, but the public API removal needs attention, so strongly recommend addressing the feedback.
| /// there might be hidden track support, which will be located at number 0. | ||
| pub number: u8, | ||
| /// starting offset, unnecessary to use directly | ||
| /// starting offset |
There was a problem hiding this comment.
Posted by Llŷr
P3: start_lba is now just starting offset, while the neighbouring start_msf gained a full explanation with units and a link. Callers do use this field directly (e.g. passing it to read_sector_range or detect_track_format), so it should state that it is the absolute Logical Block Address of the track's first sector, at the same level of detail as the MSF field.
1 participant
Description
Revise the rustdoc with all the extra additions to prepare for v1. Make docs more clear and document errors as well.