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

Often unclear where to import from #13

Closed
jlapointe opened this issue Nov 20, 2019 · 1 comment
Closed

Often unclear where to import from #13

jlapointe opened this issue Nov 20, 2019 · 1 comment
Labels
enhancement New feature or request

Comments

@jlapointe
Copy link

Many code blocks throughout the documentation don't include the import statements needed for the code to work. This means that just to try out some simple "hello world" exercises, I have to dig through the git repo (or elsewhere in the documentation) to figure out where to import things from. Usually it's not too hard, but it really interrupts the flow and gets in the way of learning the tool.

To improve this, I suggest either including the necessary import statements in all examples, or adding a section to the sidebar that lists all the components that can be imported from each package.

@JozefFlakus JozefFlakus added the enhancement New feature or request label Jan 13, 2020
@JozefFlakus
Copy link
Member

Fixed in v3.0.0 docs release

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants