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

BUG:synapseutils are not properly documented. #797

Open
larssono opened this issue Jul 14, 2020 · 0 comments
Open

BUG:synapseutils are not properly documented. #797

larssono opened this issue Jul 14, 2020 · 0 comments
Labels

Comments

@larssono
Copy link
Collaborator


Problem Description

For example the URL: https://python-docs.synapse.org/build/html/synapseutils.html#synapseutils.sync.syncToSynapse
does not contain the right documentation.

If I use synapseutils.syncToSynapse? in iPython I get the complete documentation but I can't navigate to those documentation from the doc site.

Also, it is extremely hard to find the synapseutils functions in the python documentation. It is not indexed in the left navigation and only seems findable by search or finding an existing link in one of the other function defintions.

[Explain why the current behaviour is a problem and why the proposed change is a better solution.]

Proposed Change

  • Make all of the documentation for synapseutils accessible.
  • Make it easier to navigate to the synapseutils functionality.
@larssono larssono added the bug label Jul 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant