notes.md

Notes

Documentation

• Rust By Example article
• The Rust Book: Making Useful Documentation Comments
• The rustdoc Book
• The Reference: Doc comments
• RFC 1574: API Documentation Conventions
• RFC 1946: Relative links to other items from doc comments (intra-rustdoc links)
• Is there any documentation style guide for comments? (reddit)

Running documentation locally

• Article I used
• HTTP server used

Because just navigating through the raw .html files using the file:// protocol doesn't keep the zoom level and I'm visually impaired and need to zoom in at least 150%...

1. Create index.html with <meta http-equiv="refresh" content="0; url=rusty_endsong_parser"> in target/doc
2. Run python3 -m http.server in target/doc
3. Open http://0.0.0.0:8000/ in browser and enjoy having a constant zoom level!

Lints

Useful article

Rustdoc lints

#![forbid(missing_docs)]
#![forbid(clippy::missing_docs_in_private_items)]
#![forbid(rustdoc::broken_intra_doc_links)]
#![forbid(rustdoc::private_intra_doc_links)]
#![forbid(rustdoc::missing_crate_level_docs)]
#![forbid(rustdoc::invalid_codeblock_attributes)]
#![forbid(rustdoc::invalid_rust_codeblocks)]
#![forbid(rustdoc::bare_urls)]

in main.rs

and in VSC: "rust-analyzer.checkOnSave.command": "clippy"

idk

JSON parsing

https://youtu.be/hIi_UlyIPMg

Benchmarking

With Criterion crate use also cargo criterion

Performance

very good interview - a lot applies to this program/my style of programming as well (e.g. the whole memory allocations I removed in 8b0fcdc

GitHub Copilot

good video about it and how to use it properly