Skip to content

Examples should be renamed to include simpletest #12

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
Closed
kattni opened this issue Sep 30, 2019 · 3 comments
Closed

Examples should be renamed to include simpletest #12

kattni opened this issue Sep 30, 2019 · 3 comments
Labels
good first issue

Comments

@kattni
Copy link
Contributor

kattni commented Sep 30, 2019 •
edited
Loading

  1. Example waveform_sine_demo.py should be renamed to waveform_sine_simpletest.py.
  2. Example waveform_square_demo.py should be renamed to waveform_square_simpletest.py.

This will fit with CircuitPython library standards.

The lines including this file name in the docs/examples.rst file must also be updated to reflect the name change, e.g.:

.. literalinclude:: ../examples/current_file_name.py
    :caption: examples/current_file_name.py
    :linenos:

would be updated to:

.. literalinclude:: ../examples/current_file_name_changed.py
    :caption: examples/current_file_name_changed.py
    :linenos:
@abkosar
Copy link
Contributor

abkosar commented Oct 1, 2019

Hey! I would like to work on this!

@kattni
Copy link
Contributor Author

kattni commented Oct 1, 2019

@abkosar Sounds good!

@abkosar abkosar mentioned this issue Oct 1, 2019
Merged
@kattni
Copy link
Contributor Author

kattni commented Oct 1, 2019

Fixed by #13

@kattni kattni closed this as completed Oct 1, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@kattni @abkosar