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

Add examples uses to the documentation #236

Open
timsherwood opened this issue May 31, 2018 · 0 comments
Open

Add examples uses to the documentation #236

timsherwood opened this issue May 31, 2018 · 0 comments
Labels
beginner friendly A good target for undergrads to contribute to PyRTL enhancement Proposed feature requests and improvements fix before version 1.0

Comments

@timsherwood
Copy link
Contributor

Right now the documentation has nice descriptions of the different functions, but it would be much easier to read if we small snipets of code in there that show how they can be used more easily. A picture of an example is included below. It would be great to add this to as much of the system as possible.

screen shot 2018-05-31 at 11 29 49 am
@timsherwood timsherwood added enhancement Proposed feature requests and improvements fix before version 1.0 beginner friendly A good target for undergrads to contribute to PyRTL labels May 31, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
beginner friendly A good target for undergrads to contribute to PyRTL enhancement Proposed feature requests and improvements fix before version 1.0
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@timsherwood