Skip to content

Example name requires updating to match repo name #5

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

Closed
kattni opened this issue Sep 30, 2019 · 2 comments
Closed

Example name requires updating to match repo name #5

kattni opened this issue Sep 30, 2019 · 2 comments
Labels
good first issue Good for newcomers

Comments

@kattni
Copy link
Contributor

kattni commented Sep 30, 2019

The example is currently logger_simpletest.py and should be renamed to logging_simpletest.py to match the 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:
@jimbobbennett
Copy link

@kattni - I was about to do this, but noticed it has already been done!

@FoamyGuy
Copy link
Contributor

@jimbobbennett Thank you for your willingness to work on it and pointing out that it's complete already. If you are interested in tackling a different "good first issue" type small change, there is one here: adafruit/circuitpython-org#454. If you want to work on that one I can help you if needed, feel free to ping me on that issue, or in the #help-with-circuitpython channel in the Adafruit discord.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

5 participants