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

Minor documentation fixes #1036

Merged
merged 3 commits into from
Feb 12, 2020
Merged

Minor documentation fixes #1036

merged 3 commits into from
Feb 12, 2020

Conversation

bbengfort
Copy link
Member

This PR fixes some documentation issues: particularly header underlines and correct linking to the API reference from the visualizer at-a-glance tables.

Copy link
Member

@rebeccabilbro rebeccabilbro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you so much @bbengfort for cleaning up and standardizing all the updated docs pages with the newly implemented/validated quick methods! The class/func notation is really nice 🙂 Happy to merge as is, though I wanted to note here a couple things I noticed so that I/we could take another look at them when I've had a chance to rest my eyes 😴

things to double-check

  • Prediction Error header table links aren't functioning, but I think we decided this was a necessary evil of how that class is currently implemented (i.e. in the same file as Residuals).
  • The umap quick method image curiously isn't showing up for me when I build the docs... which I think it was before. I made sure I have umap-learn installed but I must be missing something else.
  • There are a few quick method visualizations that have labels cut off - I noted postag and confusion_matrix in particular. We could try to do a tight_layout kinda thing but maybe that's overkill and we should just leave it as is?

docs/api/features/radviz.rst Outdated Show resolved Hide resolved
docs/api/features/rankd.rst Show resolved Hide resolved
docs/api/features/pca.rst Show resolved Hide resolved
@rebeccabilbro rebeccabilbro merged commit 33f1b96 into DistrictDataLabs:develop Feb 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants