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

[JOSS review] Incomplete API documentation site #579

Closed
martibosch opened this issue Jan 11, 2021 · 3 comments
Closed

[JOSS review] Incomplete API documentation site #579

martibosch opened this issue Jan 11, 2021 · 3 comments
Assignees

Comments

@martibosch
Copy link

The API documentation site is incomplete, e.g., missing spaghetti.network.Network.snapobservations, spaghetti.network.Network.split_arcs and many other relevant methods (which are in fact well documented in their respective docstrings).

openjournals/joss-reviews#2826

@jGaboardi
Copy link
Member

@martibosch the API docs for spaghetti.Network.snapobservations are here and spaghetti.network.Network.split_arcs are here. Which were the others that were missing?

@martibosch
Copy link
Author

my mistake 😓 I did not find them listed in the API documentation page but this is because they are actually methods of the Network class (which does appear in the page). Closing 💪🏻

@jGaboardi
Copy link
Member

my mistake 😓 I did not find them listed in the API documentation page but this is because they are actually methods of the Network class (which does appear in the page). Closing 💪🏻

No problem at all!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants