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

Standardize modular documentation #1365

Closed
8 tasks done
SkafteNicki opened this issue Nov 30, 2022 · 2 comments
Closed
8 tasks done

Standardize modular documentation #1365

SkafteNicki opened this issue Nov 30, 2022 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Milestone

Comments

@SkafteNicki
Copy link
Member

SkafteNicki commented Nov 30, 2022

📚 Documentation

Similar to the work done in this PR:
#1360

We want to standardize the way documentation is organised for modular metrics. This includes:

  • update and compute are excluded from docs as the docstrings are often not meaningful to begin with. Instead information about input/output tensors should be included in the class docstring
  • references are moved to the links.rst file
  • Sections are organised as
    • Introduction to metric
    • Input/output format
    • Args
    • Raises
    • examples
  • shape information is formatted as ``(N, d)`` (normal brackets and double ticks)
  • math if formatted using the :math: directive

Some of the points also apply to the functional backend, but the modular backend is of most importance because it has the largest variance in how information is organised currently.

Following domains needs to be taken care of

Any contributions are welcome :]

@SkafteNicki SkafteNicki added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Nov 30, 2022
@SkafteNicki SkafteNicki added this to the v0.12 milestone Nov 30, 2022
@theja-vanka
Copy link
Contributor

Hi, Please assign Detection task to me. A bit of grooming will be helpful to deliver asap.

@reaganjlee
Copy link
Contributor

All the docs should have been addressed now, let me know if there's anything else

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 good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants