Skip to content

Example needs renaming to match lib name #18

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 · 2 comments · Fixed by #19
Closed

Example needs renaming to match lib name #18

kattni opened this issue Sep 30, 2019 · 2 comments · Fixed by #19
Labels
good first issue Hacktoberfest

Comments

@kattni
Copy link
Contributor

kattni commented Sep 30, 2019 •
edited
Loading

One example begins with amg8xx_. It should begin with amg88x_ to match the lib name.

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:
@siqueira-ec siqueira-ec mentioned this issue Oct 1, 2019
Merged
@makermelissa
Copy link
Collaborator

Shouldn't this actually be amg88xx_?

@kattni
Copy link
Contributor Author

kattni commented Oct 3, 2019

@makermelissa Yes. The PR is still open. I will have them fix it.

@kattni kattni closed this as completed in #19 Oct 3, 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 Hacktoberfest
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Rename example and include in docs
3 participants
@makermelissa @kattni @sommersoft