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

Docs link python classes to docs #2633 #2739

Conversation

eldbud
Copy link
Contributor

@eldbud eldbud commented Oct 19, 2021

Resolves item number 2 on the original message in #2633 - link to python docs.

Added intersphinx to conf.py, also minor docs mending.

@eldbud eldbud changed the title updated intersphinx in conf.py, also minor doc fixes Docs link python classes to docst #2633 Oct 19, 2021
@Bibo-Joshi Bibo-Joshi changed the base branch from v14 to doc-fixes October 19, 2021 17:55
@eldbud eldbud changed the title Docs link python classes to docst #2633 Docs link python classes to docs #2633 Oct 19, 2021
@Bibo-Joshi Bibo-Joshi changed the base branch from doc-fixes to v14 October 19, 2021 18:00
@Bibo-Joshi Bibo-Joshi changed the base branch from v14 to doc-fixes October 19, 2021 18:00
@eldbud
Copy link
Contributor Author

eldbud commented Oct 20, 2021

@Bibo-Joshi Is there anything else i should add to this pr?

@Bibo-Joshi
Copy link
Member

Hi. As mentioned in #2738 and offline, it would be good if you build the docs and checked for places where linking to the python/APS docs is not yet used or used wrongly. Ofc I don't expect you to check every docstring manually, that's just not feasible. However, ext/_jobqueue.py is basically the only file where we would want to link to the APS docs, so that could indeed be manually checked.
If you already did that without results, then there's nothing to add to this PR :)

@eldbud
Copy link
Contributor Author

eldbud commented Oct 20, 2021

However, ext/_jobqueue.py is basically the only file where we would want to link to the APS docs, so that could indeed be manually checked.

If i am seeing correctly, the links to APScheduler appear in the doc of JobQueue, please see attached image.
If i am missing something there, of course i'd be happy to fix it
2021-10-20_19h07_16
.

@Bibo-Joshi
Copy link
Member

scheduler.add_job can be linked to BaseSchedule.add_job0- probably in the other methods as well :)

@eldbud
Copy link
Contributor Author

eldbud commented Oct 20, 2021

scheduler.add_job can be linked to BaseSchedule.add_job0- probably in the other methods as well :)

done

@Bibo-Joshi Bibo-Joshi added this to the v14 milestone Oct 21, 2021
Copy link
Member

@harshil21 harshil21 left a comment

Choose a reason for hiding this comment

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

pretty much how I would do it. If there are missing/wrong references in other parts of code, we can just fix it later

telegram/ext/_jobqueue.py Outdated Show resolved Hide resolved
eldbud and others added 2 commits October 21, 2021 14:42
Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com>
@eldbud eldbud requested a review from harshil21 October 21, 2021 11:56
telegram/ext/_jobqueue.py Outdated Show resolved Hide resolved
Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com>
@Bibo-Joshi Bibo-Joshi merged commit c02a8ea into python-telegram-bot:doc-fixes Oct 21, 2021
@Bibo-Joshi
Copy link
Member

Thanks for the contribution :)

@github-actions github-actions bot locked and limited conversation to collaborators Oct 22, 2021
@harshil21 harshil21 added the hacktoberfest-accepted Label PRs with this so that Hacktoberfest counts them as valid label Oct 30, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation hacktoberfest-accepted Label PRs with this so that Hacktoberfest counts them as valid
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants