Skip to content

Auto generate CLI options in docs #3399

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

Merged
merged 4 commits into from
Jan 25, 2021
Merged

Conversation

chao2zhang
Copy link
Member

There may be some text discrepancies between the existing cli.md and the annotation in CliArgs.kt.

@codecov
Copy link

codecov bot commented Jan 23, 2021

Codecov Report

Merging #3399 (e978b39) into master (b0041fe) will decrease coverage by 0.05%.
The diff coverage is 44.44%.

Impacted file tree graph

@@             Coverage Diff              @@
##             master    #3399      +/-   ##
============================================
- Coverage     80.40%   80.34%   -0.06%     
- Complexity     2745     2747       +2     
============================================
  Files           448      449       +1     
  Lines          8279     8295      +16     
  Branches       1582     1584       +2     
============================================
+ Hits           6657     6665       +8     
- Misses          767      774       +7     
- Partials        855      856       +1     
Impacted Files Coverage Δ Complexity Δ
...io/gitlab/arturbosch/detekt/generator/Generator.kt 0.00% <0.00%> (ø) 0.00 <0.00> (ø)
...itlab/arturbosch/detekt/generator/GeneratorArgs.kt 0.00% <0.00%> (ø) 0.00 <0.00> (ø)
.../arturbosch/detekt/generator/out/AbstractWriter.kt 0.00% <0.00%> (ø) 0.00 <0.00> (ø)
...osch/detekt/generator/printer/CliOptionsPrinter.kt 88.88% <88.88%> (ø) 2.00 <2.00> (?)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b0041fe...e978b39. Read the comment docs.

Copy link
Member

@BraisGabin BraisGabin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this! Is there a way in jekyll to include one markdown inside another? It could be great to keep this in the same document I think.

Anyway, we can merge this because the important thing here is to have a reliable documentation.

@chao2zhang
Copy link
Member Author

I like this! Is there a way in jekyll to include one markdown inside another? It could be great to keep this in the same document I think.

Anyway, we can merge this because the important thing here is to have a reliable documentation.

The only limitation is that we cannot include files in the parent path ../ according to https://jekyllrb.com/docs/includes/#including-files-relative-to-another-file

Copy link
Member

@BraisGabin BraisGabin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏🏻👏🏻👏🏻

@chao2zhang chao2zhang merged commit 6d7374b into detekt:master Jan 25, 2021
@chao2zhang chao2zhang deleted the cli-doc branch January 25, 2021 16:19
@cortinico cortinico added the housekeeping Marker for housekeeping tasks and refactorings label Feb 19, 2021
@cortinico cortinico added this to the 1.16.0 milestone Feb 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
housekeeping Marker for housekeeping tasks and refactorings
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants