Safety check before running File.rm_rf! in doc gen #1707
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
josevalim
reviewed
May 21, 2023
josevalim
reviewed
May 22, 2023
josevalim
reviewed
May 22, 2023
|
Is there anything that still needs to be done in this PR? |
|
💚 💙 💜 💛 ❤️ |
josevalim
added a commit
that referenced
this pull request
Oct 20, 2023
Unfortunately this is generating ExDoc files with mixed entries. This reverts commit 9766ed7.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull requests adds a safety check before running
Fille.rm_rf!when creating docs.Now it will only allow users to select as output either:
.ex_docfile)One I think inevitable outcome of this is that this is a breaking change, users with existing
docsfolders that try to run it in a new version will receive the error message.Maybe we can add a line in the error saying
Run "rm -rf docs" if you are seeing this after upgrading ex_docCloses #1555