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

Doc cleanup #64

Open
5 tasks
dosumis opened this issue May 10, 2021 · 0 comments
Open
5 tasks

Doc cleanup #64

dosumis opened this issue May 10, 2021 · 0 comments

Comments

@dosumis
Copy link
Member

dosumis commented May 10, 2021 •
edited
Loading

We now have almost complete doc, but it requires some tidying up:

  • Update top README.md (this appears as main text on PyPi)
  • Docstrings - Fix typos & inconsistencies. (Print out API doc to work through)
  • API reference doc intro is poorly written & confusing. Better to write something more function oriented. Base on QuickStart intro doc. Make path/attribute clarification into a side note. (can this be a box?)
  • Move Object initialisation doc from __init__ to class & better standardise.
  • Cut down & edit discovery and connectomics notebooks to be VFB specific + add output limits & make sure screenshots from VFB are present.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dosumis