Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Issue35 documentation #98

Merged
merged 5 commits into from
Sep 24, 2020

Conversation

samanthahamilton
Copy link
Contributor

Documentation on "Examples" page

Adjustments for readability; final steps of Issue #35 and some adjustments from Issue #63

  • Adjustments made for grammar, readability, capitalization, and punctuation
  • Adjustments for style guide (ex: numpy to NumPy, etc.)
  • Fixed remaining single to double backticks

Page Status:
✔ README
✔ Index
✔ Installation
✔ Matplotlib Backends
✔ Comparison to ipywidgets
✔ API
✔ Examples
✔ Gallery - n/a
✔ Contributing

Final edits to Examples.rst pages (1/4)
Final edits to Examples.rst pages (2/4)
Final edits to Examples.rst pages (3/4)
Final edits to Examples.rst pages (4/4)
@samanthahamilton
Copy link
Contributor Author

Hi, @ianhi,

These are the final page edits, as I can see right now. There are only a few tiny things I would go back and fix (if you want me to):

  • Adjust the headers so H1, H2, H3, H4 are the same across all pages
  • Any stylistic changes you wanted to be done (draft example: PR Webdesign #95)
  • You mentioned the docstrings in PR Update index.rst #64

Other than that---I think you have an amazing set of web docs! 🎉 🥳
Best,
Sam.

@ianhi
Copy link
Collaborator

ianhi commented Sep 24, 2020

Hi @samanthahamilton I'm really sorry I let this get away from me so much. Had a stressful few weeks, and then I felt bad about not having looked at this and then vicious cycle etc :(...

As ever these are great edits! Idk if I'm an official enough person to be listed as a reference but you should absolutely feel to what you did here when advertising yourself, and I'd be happy to speak well on your behalf.

@ianhi ianhi merged commit 9bdbb32 into mpl-extensions:master Sep 24, 2020
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants