Skip to content
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

[DOC, ENH] Shorten descriptions of clean and toc functions #693

Merged
merged 1 commit into from Jun 4, 2020

Conversation

pgadige
Copy link
Contributor

@pgadige pgadige commented Jun 4, 2020

This PR attempts to solve #659

Shortened the descriptions of CLI's clean and toc functions by rephrasing the text of their docstrings.

Signed-off-by: pgadige poojagadige@gmail.com

Signed-off-by: pgadige <poojagadige@gmail.com>
@pgadige pgadige marked this pull request as ready for review June 4, 2020 09:23
@pgadige
Copy link
Contributor Author

pgadige commented Jun 4, 2020

@choldgraf, I appreciate your review and feedback on this specific solution.

@akhmerov
Copy link
Contributor

akhmerov commented Jun 4, 2020

This is awesome! I'm only wondering whether _build and jupyter_cache are clear to the user, as opposed to e.g. "compiled documents" and "execution results".

@choldgraf
Copy link
Member

I think it's OK to use the specific folders, just to be more explicit (and to keep the docstrings shorter). Thanks very much @pgadige for the contribution!

@choldgraf choldgraf merged commit f3874d5 into executablebooks:master Jun 4, 2020
@pgadige pgadige deleted the shorten-description branch June 5, 2020 05:04
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.

None yet

3 participants