Skip to content

Remove or improve [source] links in method descriptions #675

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.

Sign up for GitHub

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

Jump to bottom
Closed
jklaise opened this issue May 17, 2022 · 0 comments
Closed

Remove or improve [source] links in method descriptions #675

jklaise opened this issue May 17, 2022 · 0 comments
Labels
Good first issue Good for newcomers Type: Docs Anything related to documentation

Comments

@jklaise
Copy link
Contributor

jklaise commented May 17, 2022

Notices that the [source] links at the top of method descriptions are sometimes broken, don't exist, or if functional, lead to the implementation module which should be considered private. Proposing to either completely remove these links or linking to the relevant API documentation in the public API.
@jklaise jklaise added Type: Docs Anything related to documentation Good first issue Good for newcomers labels May 17, 2022
mauicv added a commit to mauicv/alibi that referenced this issue Jun 13, 2022
@mauicv
Fix broken source links in docs, fix SeldonIO#675
a38c0ab
@mauicv mauicv mentioned this issue Jun 13, 2022
Merged
@mauicv mauicv closed this as completed in efac30c Jun 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Good first issue Good for newcomers Type: Docs Anything related to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jklaise