Closed choldgraf closed 3 years ago
Thanks for submitting your first pull request! You are awesome! :hugs:
If you haven't done so already, check out EBP's Code of Conduct and our Contributing Guide, as this will greatly help the review process.
Welcome to the EBP community! :tada:
Merging #34 (d56978e) into main (e651a89) will not change coverage. The diff coverage is
100.00%
.
@@ Coverage Diff @@
## main #34 +/- ##
=======================================
Coverage 90.23% 90.23%
=======================================
Files 6 6
Lines 645 645
=======================================
Hits 582 582
Misses 63 63
Flag | Coverage Δ | |
---|---|---|
pytests | 90.23% <100.00%> (ø) |
Flags with carried forward coverage won't be shown. Click here to find out more.
Impacted Files | Coverage Δ | |
---|---|---|
sphinx_external_toc/__init__.py | 92.85% <ø> (ø) |
|
sphinx_external_toc/cli.py | 89.09% <100.00%> (ø) |
Continue to review full report at Codecov.
Legend - Click here to learn more
Δ = absolute <relative> (impact)
,ø = not affected
,? = missing data
Powered by Codecov. Last update e651a89...d56978e. Read the comment docs.
I think this is too generic (files of what). I saw you mention to-project; something like that would seem better (get out the thesaurus)
what about "pages"? sections?
to-pages
from-pages
?to-sections
from-sections
?what about to-documents
and from-documents
Perhaps a bit long? to-docs
(although that sounds like the shorthand for Documentation
)
I also don't mind to-project
and from-project
Sounds good - I'm fine w/ project
as well.
I just pushed a change that uses project
instead of files
. It also updates site
-> project
in the docs and docstrings.
I had a chat this morning with @chrisjsewell - I think the plan is:
I think this is fine cheers. Because I'm too lazy, can you create another PR after I merge this, with the 0.2.0 version and change log entry
Congrats on your first merged pull request in this project! :tada:
Thank you for contributing, we are very proud of you! :heart:
This PR renames the two CLI commands:
to-site
andfrom-site
to instead be:
to-files
andfrom-files
The rationale for this is to avoid using web-specific terminology (website) and also to be more explicit in what these functions are doing (building a TOC from files on disk, and building files on disk from the TOC).
NOTE: this is a breaking change from an API perspective, since we have technically released 1.0 we should bump to 2.0. Alternatively we could use click aliases to allow for both commands to be used?