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

Add flag to generate documentation only for specifics tags #1379

Merged
merged 2 commits into from
Nov 20, 2022

Conversation

Trial97
Copy link
Contributor

@Trial97 Trial97 commented Nov 9, 2022

Describe the PR
Added CLI flag to generate the doc for them if specified.
It helps when you want to generate multiple pieces of documentation(e.g. one for devs and a separate one for customers)

Relation issue
None

Additional context
ToDo:

  • Add a flag to the parser
  • Add tests

@Trial97 Trial97 marked this pull request as ready for review November 10, 2022 08:55
@ubogdan
Copy link
Contributor

ubogdan commented Nov 16, 2022

@Trial97 Not sure about it.

@Trial97
Copy link
Contributor Author

Trial97 commented Nov 17, 2022

@ubogdan Feel free to close it if this is not desired :D.
But why not? Does this PR lack in some way or form?

@ubogdan ubogdan requested a review from sdghchj November 20, 2022 11:28
@ubogdan
Copy link
Contributor

ubogdan commented Nov 20, 2022

@Trial97 I'll like to hear @sdghchj opinion.

@codecov
Copy link

codecov bot commented Nov 20, 2022

Codecov Report

Base: 95.71% // Head: 95.76% // Increases project coverage by +0.04% 🎉

Coverage data is based on head (5d3f2e0) compared to base (eaed517).
Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1379      +/-   ##
==========================================
+ Coverage   95.71%   95.76%   +0.04%     
==========================================
  Files          14       14              
  Lines        2826     2855      +29     
==========================================
+ Hits         2705     2734      +29     
  Misses         66       66              
  Partials       55       55              
Impacted Files Coverage Δ
gen/gen.go 93.45% <100.00%> (+0.03%) ⬆️
parser.go 93.90% <100.00%> (+0.21%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@sdghchj
Copy link
Member

sdghchj commented Nov 20, 2022

@ubogdan
I agree on this feature, for my team had also asked for it some days ago.
We usually need a piece of open API for customers and another piece for develpers in our own team.

Copy link
Contributor

@ubogdan ubogdan left a comment

Choose a reason for hiding this comment

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

LGTM

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.

3 participants