search

Holzhaus / rekordcrate

Library for parsing Pioneer Rekordbox device exports
https://holzhaus.github.io/rekordcrate/
Mozilla Public License 2.0
80 stars 12 forks source link

style(lint): only warn on missing docs #96

Closed Swiftb0y closed 1 year ago

Swiftb0y commented 2 years ago

Otherwise the build fails when you just want to prototype. The workaround of spamming /// TODO everywhere leads to oversights.

Holzhaus commented 2 years ago

When prototyping you can just put

#![allow(missing_docs)]

at the top of the module that you're working on.

Holzhaus commented 2 years ago

If we merged this, does pre commit still fail on missing docs?

Swiftb0y commented 2 years ago

probably not, maybe we could change the lint level to only deny(missing_docs) when clippy is run? Though if that doesn't work reliably just adding #![allow(missing_docs)] at the top is probably better. I don't know when I'll have the time to investigate.

Holzhaus commented 1 year ago

Just tested this, pre-commit still fails so I see no issue with merging this.

Swiftb0y commented 1 year ago

Thank you. Glad to see you finding the time to revive this repo. I'll probably don't have the time to do reverse-engineering own my own right now but I'll try to help out in the form of reviews as much as I can. IIRC there has been some new insight being shared on https://deep-symmetry.zulipchat.com/#narrow/stream/275855-dysentery-.26-crate-digger which allowed some people to create mostly working exports.