Metrics as autosummary tables#4774
Conversation
Codecov Report
@@ Coverage Diff @@
## master #4774 +/- ##
=======================================
+ Coverage 90% 93% +3%
=======================================
Files 117 117
Lines 8968 8968
=======================================
+ Hits 8084 8335 +251
+ Misses 884 633 -251 |
Borda
left a comment
There was a problem hiding this comment.
can we add screenshot of the new one?
|
|
tchaton
left a comment
There was a problem hiding this comment.
Hey @SkafteNicki, looks great ! Thanks !
rohitgr7
left a comment
There was a problem hiding this comment.
LGTM. Just some comments.
Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
williamFalcon
left a comment
There was a problem hiding this comment.
before merging can i clarify something?
the metric summary tables remove the menus on the right that make it super easy to search for stuff without having to scroll endlessly through the page.
is that menu gone now?
if so, can we undo all these summary tables? they make quickly scanning to see what’s available impossible.
to see how useful this menu is, try finding any trainer flag. now imagine if the menu ok the right didn’t exist and you instead had to scroll the full page just to see what flags are available.
remember that our docs are as much about discovery as they are about referencing
|
The menu is not all gone, it still expands to the individual types of metrics: |
|
right. this is exactly what i think is not a great user experience. we now remove the ability for the user to discover what is available by just glancing at the right since all the metrics are gone from the menu. i also want to remove these tables from the rest of the docs. this approach assumes people know what they are looking for but makes it impossible for people who are just browsing to see what’s available... and actually the menu on the right showing the list of metrics is much much faster to find the metric you are looking for. @tchaton, @edenafek can we remove these tables from the docs and do it exactly like we do for trainer flags? |
|
Hey @SkafteNicki, After chatting with Will, I deeply apologise as you invested time working on this and it won't get integrated. Best regards, |
|
@tchaton it is completely fine, I did not spend that much time on this PR :] |
What does this PR do?
Reformat metric docs to use autosummary.
Requested by @tchaton on slack :]
Before submitting
PR review
Anyone in the community is free to review the PR once the tests have passed.
Before you start reviewing make sure you have read Review guidelines. In in short, see following bullet-list:
Did you have fun?
Make sure you had fun coding 🙃