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

Documentation: Metric Descriptions #10

Closed
alexanderlerch opened this issue Dec 4, 2021 · 2 comments · Fixed by #11 or #14
Closed

Documentation: Metric Descriptions #10

alexanderlerch opened this issue Dec 4, 2021 · 2 comments · Fixed by #11 or #14
Assignees
@karnwatcharasupat @jylee-k
Labels
priority: high type: documentation Improvements or additions to documentation
Projects
Latte
Milestone
v0.1.0 release

Comments

@alexanderlerch
Copy link
Collaborator

Might be nice to provide a short description for each metric in addition to the paper links. The readme might get too long with it, but either some doc in the repo or maybe on a github.io page?
@karnwatcharasupat karnwatcharasupat self-assigned this Dec 4, 2021
@karnwatcharasupat karnwatcharasupat added type: documentation Improvements or additions to documentation type: enhancement Enhancement request on existing features !! needs more hands !! Extra labour is needed labels Dec 4, 2021
@karnwatcharasupat
Copy link
Owner

Hi Alex, thanks for the suggestion! I will add it to the readthedocs page in an upcoming push.

@jylee-k are you free to help me with this as well?

@jylee-k
Copy link
Collaborator

jylee-k commented Dec 5, 2021

Yes sure.

@karnwatcharasupat karnwatcharasupat mentioned this issue Dec 5, 2021
Merged
@karnwatcharasupat karnwatcharasupat added this to the v0.1.0 release milestone Dec 8, 2021
@karnwatcharasupat karnwatcharasupat removed the !! needs more hands !! Extra labour is needed label Dec 8, 2021
@karnwatcharasupat karnwatcharasupat linked a pull request Dec 20, 2021 that will close this issue
[ADD] Metric Descriptions #14
Merged
@karnwatcharasupat karnwatcharasupat removed the type: enhancement Enhancement request on existing features label Dec 21, 2021
@karnwatcharasupat karnwatcharasupat added this to To do in Latte via automation Jan 2, 2022
@karnwatcharasupat karnwatcharasupat pinned this issue Jan 4, 2022
Latte automation moved this from To do to Done Jan 6, 2022
karnwatcharasupat added a commit that referenced this issue Jan 6, 2022
@karnwatcharasupat
Merge pull request #14 from /issues/10-docs
b51023f 
[ADD] Metric Descriptions
@karnwatcharasupat karnwatcharasupat unpinned this issue Jan 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@karnwatcharasupat karnwatcharasupat

@jylee-k jylee-k

Labels
priority: high type: documentation Improvements or additions to documentation
Projects
Latte
Done
Milestone
v0.1.0 release
3 participants
@alexanderlerch @karnwatcharasupat @jylee-k