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

Doc/glossary #537

Merged
merged 14 commits into from
Mar 26, 2024
Merged

Doc/glossary #537

merged 14 commits into from
Mar 26, 2024

Conversation

mdbenito
Copy link
Collaborator

@mdbenito mdbenito commented Mar 23, 2024

Description

This PR adds a glossary page. I almost exclusively took terms from abbreviations.md but we should add more that are relevant to pydvl. Links to wikipedia / other sources might be in order too.

@schroedk the influence part is again a stub, please check it for consistency and completeness. @AnesBenmerzoug let me know of any terms that you miss and I'll try to add them.

At some point we will want to link to these from other docs. So maybe I'll try adding explicit anchors with { #anchor }, although that has not really worked out so well in the past.

Changes

Checklist

  • Wrote Unit tests (if necessary)
  • Updated Documentation (if necessary)
  • Updated Changelog
  • If notebooks were added/changed, added boilerplate cells are tagged with "tags": ["hide"] or "tags": ["hide-input"]

@mdbenito mdbenito added the documentation Improvements or additions to documentation label Mar 23, 2024
@mdbenito mdbenito added this to the v0.9.0 milestone Mar 23, 2024
@AnesBenmerzoug
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.

@mdbenito
Copy link
Collaborator Author

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.

Well... you suggested it 😅 But I'm not sure it's redundant. 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).

Co-authored-by: Anes Benmerzoug <[email protected]>
@AnesBenmerzoug
Copy link
Collaborator

That sounds like a lot of work. I think we can merge it now as it is.

AnesBenmerzoug
AnesBenmerzoug previously approved these changes Mar 24, 2024
@mdbenito mdbenito merged commit 920aa9e into develop Mar 26, 2024
2 of 22 checks passed
@mdbenito mdbenito deleted the doc/glossary branch March 26, 2024 09:42
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

Successfully merging this pull request may close these issues.

Create separate page for glossary of terms
3 participants