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.

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

[docs] Internal references of your docs #7

Closed
lrnv opened this issue Oct 30, 2023 · 3 comments
Closed

[docs] Internal references of your docs #7

lrnv opened this issue Oct 30, 2023 · 3 comments

Comments

@lrnv
Copy link

lrnv commented Oct 30, 2023

Your documentation does not link with itself enough for discoverability of your functions. You might include on major documentation pages a see also note to provide a few others links to docuimentation of functions in your package that are relevant to this function.
@lrnv lrnv mentioned this issue Oct 30, 2023
Closed
ahudde pushed a commit that referenced this issue Feb 15, 2024
#7: Internal refernces in the documentation
edddccd
ahudde pushed a commit that referenced this issue Feb 16, 2024
#7: Internal references of your docs
e7b20e5
ahudde pushed a commit that referenced this issue Feb 16, 2024
#7: Internal references of docs
a498a63
@ahudde
Copy link
Owner

ahudde commented Feb 16, 2024

Dear @lrnv,
Thanks, that is a good point. I added the relevant seealso-notes. What do you think?

Best,
Anselm

@lrnv
Copy link
Author

lrnv commented Feb 16, 2024

Yep this is what I intended !

@lrnv lrnv closed this as completed Feb 16, 2024
@ahudde
Copy link
Owner

ahudde commented Feb 16, 2024

Great, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@lrnv @ahudde