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

impr: add param example to readme #1189

Merged
merged 1 commit into from Apr 27, 2022
Merged

impr: add param example to readme #1189

merged 1 commit into from Apr 27, 2022

Conversation

jeniasaigak
Copy link
Contributor

Describe the PR
Add example param details to the README.md.

Relation issue
#1119

Additional context
The support for the parameter was added at #1122, at scope of #1119, but there are no details about this flag at the README. To find this details, I was needed to look at the related issues, so I've decided to add this details to the README to simplify searches for others who may need this feature

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

@codecov
Copy link

codecov bot commented Apr 27, 2022

Codecov Report

Merging #1189 (9a1ae5a) into master (636f456) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #1189   +/-   ##
=======================================
  Coverage   95.03%   95.03%           
=======================================
  Files          10       10           
  Lines        2557     2557           
=======================================
  Hits         2430     2430           
  Misses         69       69           
  Partials       58       58           

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 636f456...9a1ae5a. Read the comment docs.

@ubogdan ubogdan merged commit 5f6c5f8 into swaggo:master Apr 27, 2022
@ubogdan
Copy link
Contributor

ubogdan commented Apr 27, 2022

@zmefz Thanks for your contribution.

@jeniasaigak jeniasaigak deleted the add_example_to_readme branch April 27, 2022 13:43
jixiuf pushed a commit to jixiuf/swag that referenced this pull request May 17, 2022
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.

None yet

2 participants