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

Document lib/demo.g #3909

Open
ssiccha opened this issue Mar 1, 2020 · 0 comments
Open

Document lib/demo.g #3909

ssiccha opened this issue Mar 1, 2020 · 0 comments
Assignees
@stevelinton
Labels
kind: enhancement Label for issues suggesting enhancements; and for pull requests implementing enhancements release notes: to be added PRs introducing changes that should be (but have not yet been) mentioned in the release notes topic: documentation Issues and PRs related to documentation

Comments

@ssiccha
Copy link
Contributor

ssiccha commented Mar 1, 2020

The functions in this file are undocumented, but used for example by the scscp package, see #3908.

We could document the most useful functions, unless there is some reason why we don't want people to use this function? The documentation should mention that one can build more sophisticated demos with the browse package or via jupyter.
@ssiccha ssiccha added kind: enhancement Label for issues suggesting enhancements; and for pull requests implementing enhancements topic: documentation Issues and PRs related to documentation release notes: to be added PRs introducing changes that should be (but have not yet been) mentioned in the release notes labels Mar 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@stevelinton stevelinton

Labels
kind: enhancement Label for issues suggesting enhancements; and for pull requests implementing enhancements release notes: to be added PRs introducing changes that should be (but have not yet been) mentioned in the release notes topic: documentation Issues and PRs related to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@stevelinton @ssiccha