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

The glossary makes the methods page redundant? #547

Open
mdbenito opened this issue Mar 26, 2024 · 1 comment
Open

The glossary makes the methods page redundant? #547

mdbenito opened this issue Mar 26, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@mdbenito
Copy link
Collaborator

The new Glossary page makes the Methods page a bit redundant because it contains descriptions of some of the methods as well as links to the implementations. Perhaps we can keep method descriptions in Methods and only put other terms in the Glossary.

Originally posted by @AnesBenmerzoug in #537 (comment)

@mdbenito
Copy link
Collaborator Author

Reply

The methods page is a quick list with links for reference for newcomers ("is my algorithm here?"). Whereas the glossary is for quick definitions that can be linked from anywhere. I would imagine that in time, if we really want the glossary to be useful, we'd cross-ref to it from all over the docs, possibly adding a little tooltip with the definition (using e.g. the couple of js+css files suggested here).

@mdbenito mdbenito added the documentation Improvements or additions to documentation label Mar 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant