Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

book: generate command pages #835

Merged
merged 1 commit into from
Nov 10, 2024
Merged

book: generate command pages #835

merged 1 commit into from
Nov 10, 2024

Conversation

BrettMayson
Copy link
Owner

@BrettMayson BrettMayson commented Nov 10, 2024

Moves the documentation into the respective source files, using doc comments, make the programmer more aware of them

Prevents any arguments from being added and forgotten about in the book, which there was at least one case of

Copy link

codecov bot commented Nov 10, 2024

Codecov Report

Attention: Patch coverage is 6.25000% with 15 lines in your changes missing coverage. Please review.

Project coverage is 68.9%. Comparing base (83ef17c) to head (3e0649a).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
bin/src/commands/localization/coverage.rs 0.0% 8 Missing ⚠️
bin/src/commands/localization/sort.rs 0.0% 2 Missing ⚠️
bin/src/utils/paa/inspect.rs 0.0% 2 Missing ⚠️
bin/src/utils/pbo/inspect.rs 0.0% 2 Missing ⚠️
bin/src/commands/dev.rs 50.0% 1 Missing ⚠️
Additional details and impacted files
Files with missing lines Coverage Δ
bin/src/commands/build.rs 85.1% <ø> (ø)
bin/src/commands/check.rs 0.0% <ø> (ø)
bin/src/commands/launch/mod.rs 6.4% <ø> (ø)
bin/src/commands/localization/mod.rs 0.0% <ø> (ø)
bin/src/commands/new/mod.rs 74.0% <ø> (ø)
bin/src/commands/release.rs 85.0% <ø> (ø)
bin/src/commands/script.rs 88.8% <ø> (ø)
bin/src/lib.rs 63.5% <ø> (ø)
bin/src/commands/dev.rs 77.7% <50.0%> (ø)
bin/src/commands/localization/sort.rs 0.0% <0.0%> (ø)
... and 3 more

@BrettMayson BrettMayson merged commit cce59ce into main Nov 10, 2024
21 of 23 checks passed
@BrettMayson BrettMayson deleted the auto_book branch November 10, 2024 07:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant