Skip to content

Conversation

@s-light
Copy link
Contributor

@s-light s-light commented Nov 29, 2018

TODO: define naming convention for example files

in my library there are some examples and development helpers that are
not starting with the library name -
in the community_bundle build all examples are thrown together in one example folder for all libraries -
is this a good idea??
if every library has a simple_example.py that does not work...

please let me know what you think of this.
for me iam fine with renaming my examples so they all start with the library name.

@tannewt
Copy link
Member

tannewt commented Dec 3, 2018

I believe we do have a standard for example names that includes the library name. It's done this way because its expected that the files will move. @sommersoft and @kattni will know exactly what the normal form is.

Thanks for the library!

@kattni
Copy link
Contributor

kattni commented Dec 3, 2018

The standards for example naming is as follows. The initial simple test example should be called libraryname_simpletest.py. Any other included examples should be called libraryname_examplename.py. Thanks!

s-light added a commit to s-light/slight_CircuitPython_TLC5957 that referenced this pull request Dec 4, 2018
@s-light
Copy link
Contributor Author

s-light commented Dec 4, 2018

thanks for the info!
i thought i have read all the tutorials and guides carefully but i can't remember that this was in there somewhere ;-)
i have renamed the examples.
here is the next question regarding the library name..
i prefixed the library with my slightname (i have done this also with all my arduino libraries in the past)
the idea for me was - if someone else wants to create a library - i think its fair to not use only the chip-name...
→ i have renamed all examples to match the library name..

@tannewt
Copy link
Member

tannewt commented Dec 6, 2018

Thanks! We like that prefix style as well.

@tannewt tannewt merged commit c269a05 into adafruit:master Dec 6, 2018
@s-light s-light deleted the slight_tlc5957 branch December 6, 2018 21:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants