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

[Python] 5094 followup - Reduce redundancy in docs #5161

Merged
merged 2 commits into from
Feb 6, 2020

Conversation

fabianvf
Copy link
Contributor

This is a followup to PR #5094, which had a few unresolved comments at merge time. This reduces the amount of redundant lines in the api example doc templates, and ensures that referenced Configuration objects are actually instantiated.

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

cc @taxpon @frol @mbohlool @cbornet @kenjones-cisco @tomplus @Jyhess @slash-arun @spacether

@spacether spacether changed the title 5094 followup - Reduce redundancy in python docs [Python] 5094 followup - Reduce redundancy in docs Jan 30, 2020
Copy link
Contributor

@spacether spacether left a comment

Choose a reason for hiding this comment

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

Please instantiate a configuration instance in the endpoint docs if that endpoint has at least one auth method

This is a followup to PR OpenAPITools#5094, which had a few unresolved comments at
merge time. This reduces the amount of redundant lines in the api
example doc templates, and ensures that referenced Configuration objects
are actually instantiated.
@spacether spacether closed this Feb 6, 2020
@spacether spacether reopened this Feb 6, 2020
Copy link
Contributor

@spacether spacether left a comment

Choose a reason for hiding this comment

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

@fabianvf thank you for this PR!
It looks good.
I am just waiting for the CI tests to pass.

Copy link
Contributor

@spacether spacether left a comment

Choose a reason for hiding this comment

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

Your CircleCI test are failing because other python generator samples need to be regenerated with your updates. bin/ensure-up-to-date will regenerate those samples.
Once the tests pass, this PR can be merged.
Can you run bin/ensure-up-to-date?

@fabianvf
Copy link
Contributor Author

fabianvf commented Feb 6, 2020

@spacether was running it as you typed :)

@fabianvf
Copy link
Contributor Author

fabianvf commented Feb 6, 2020

@spacether think it's just blocked on your review now

Copy link
Contributor

@spacether spacether left a comment

Choose a reason for hiding this comment

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

Looks good

@spacether spacether merged commit c943ecf into OpenAPITools:master Feb 6, 2020
MikailBag pushed a commit to MikailBag/openapi-generator that referenced this pull request Mar 23, 2020
* Reduce redundancy in python docs

This is a followup to PR OpenAPITools#5094, which had a few unresolved comments at
merge time. This reduces the amount of redundant lines in the api
example doc templates, and ensures that referenced Configuration objects
are actually instantiated.

* Regenerate samples
@wing328 wing328 added this to the 4.3.0 milestone Mar 26, 2020
@wing328
Copy link
Member

wing328 commented Mar 27, 2020

@fabianvf thanks for the PR, which has been included in the 4.3.0 release: https://twitter.com/oas_generator/status/1243455743937789952

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants