Add Rust Docs CI #1271
Add Rust Docs CI #1271
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1271 +/- ##
==========================================
- Coverage 19.30% 4.27% -15.03%
==========================================
Files 164 94 -70
Lines 10849 6079 -4770
==========================================
- Hits 2094 260 -1834
+ Misses 8755 5819 -2936
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
A couple of general notes:
- I think at this point we should just have a single
rust.ymlfile in the CI and do all the rust-related stuff, like building/testing/docs/msrv.. It is getting crowded here because we add a new file for each action - I think it should be enough to add the
denymacro tomain/lib, it should be reflected across the crate?
1 would be good on a separate PR 2 is interesting feedback, but the engineering effort is higher, because we would need human eyes going with a fine comb over each module do you feel strongly about this? the current approach is naive and not elegant, but it gets the job done without significant negative consequences |
|
for (1) #1272 with (2), what is the difference when you include the flag in every files? |
|
closing this after trying to implement all the changes on introducing the to make the CI happy, we would need to spend too much human hours adding redundant docs I'm not against having this CI... if someone is opinionated and wants to spend time on making this PR ready, feel free to spend time on it (e.g.: @Shourya742 ) I just don't want to spend my time here, I feel there's higher prio things to be done right now |
|
Maybe we can ignore all that functions that we don't want to documents and
still add it?
…On Mon, Dec 9, 2024, 2:01 PM plebhash ***@***.***> wrote:
closing this
after trying to implement all the changes on roles_logic_sv2 I quickly
realized that the engineering effort here is not worth it
introducing the deny(missing_docs) macro, A LOT of new errors come up
to make the CI happy, we would need to spend too much human hours adding
redundant docs
------------------------------
I'm not against having this CI... if someone is opinionated and wants to
spend time on making this PR ready, feel free to spend time on it (e.g.:
@Shourya742 <https://github.com/Shourya742> )
I just don't want to spend my time here, I feel there's higher prio things
to be done right now
—
Reply to this email directly, view it on GitHub
<#1271 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ABPLMPISJITD74453C6F5X32EVS73AVCNFSM6AAAAABTCEBLE2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDKMRXGQ3DEMRXHA>
.
You are receiving this because you are subscribed to this thread.Message
ID: ***@***.***>
|
close #1270
this PR does two things:
#![deny(missing_docs)]on every*.rsfile that still doesn't have itcargo doc --all-featureson every crate of the repo (via shell recursion)we should aim to merge this PR by the end of Milestone 1.2.0
this will be the final toothcomb that will give us confidence to move forward from #845 knowing that we didn't let anything go without notice