Skip to content

Two examples need renaming to match lib name #39

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 · 4 comments
Closed

Two examples need renaming to match lib name #39

kattni opened this issue Sep 30, 2019 · 4 comments

Comments

@kattni
Copy link
Contributor

kattni commented Sep 30, 2019

Two examples begin with ads1015_ and ads1115_. They should each begin with ads1x15_ads1015_ and ads1x15_ads1115_ to match the CIrcuitPython library standards and make it clearer in the example bundle which library they are associated with.

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:
@razinc
Copy link
Contributor

razinc commented Oct 12, 2019

Hi @kattni. I would like to take this but I don't have a clear picture of the issue. One of the requirements is changing the word ads1015_ to ads1x15_ads1015_ & ads1115_ to ads1x15_ads1115_ in docs/examples.rst. Does it mean I have to put the prefix ads1x15 to each file in this repo?

@kattni
Copy link
Contributor Author

kattni commented Oct 12, 2019

Hello, @razinc.

The prefix ads1x15_ needs to be added to two of the example files in this repo (the two files that include simpletest in the name), the two other examples already have that as the beginning of their name (the two files that do not include simpletest in their name).

Once the filenames are changed, the docs/examples.rst file needs the file names in it updated, as it includes both of the files that need to be renamed.

@razinc
Copy link
Contributor

razinc commented Oct 12, 2019

Okay. Let me take this, please.

@evaherrada
Copy link
Collaborator

Closed. Fixed in #41

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants