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

Fix docstring generation of jira client and minor doc layouting fix #1038

Merged
merged 3 commits into from May 15, 2021

Conversation

studioj
Copy link
Collaborator

@studioj studioj commented May 13, 2021

https://jira.readthedocs.io/en/master/api.html#jira.JIRA doesn't contain the info about the 'auth=' parameter. First commit should fix that

@studioj
Copy link
Collaborator Author

studioj commented May 13, 2021

added warnings in the examples for using auth=(username, password) and basic_auth=(username, password)
(updated docu will look like this)

this commit could be dropped if needed

@studioj studioj force-pushed the fix_docstring_generation_of_jira_client branch from 9b416c2 to 410cdc5 Compare May 13, 2021 23:45
@studioj studioj force-pushed the fix_docstring_generation_of_jira_client branch from 410cdc5 to 561fa25 Compare May 13, 2021 23:52
@studioj
Copy link
Collaborator Author

studioj commented May 13, 2021

last commit should fix the layout of the white background in relation with the line length

before:

after:

@ssbarnea ssbarnea merged commit 16c1053 into master May 15, 2021
@delete-merged-branch delete-merged-branch bot deleted the fix_docstring_generation_of_jira_client branch May 15, 2021 12:10
@ssbarnea ssbarnea added the bug label Oct 4, 2021
svermeulen pushed a commit to svermeulen/jira that referenced this pull request Oct 31, 2021
…ycontribs#1038)

* some part of the documentation wasn't properly generated.
see pycontribs#1035

* adding warnings about deprecated auth mechanism for jira cloud in examples

* this should fix the mismatch between the white background and the line length of the docs

Co-authored-by: Neefs, Jef <jef.neefs@barco.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants