-
Notifications
You must be signed in to change notification settings - Fork 412
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
Separate “undocumented.json” from “docs”? #754
Comments
The original rationale was to make it easy for developers — and especially for developer tools — to open the offending file. It's the same reason why compilers, linters, and other build tools often emit full paths, though granted they usually send those paths to the console and not a file. |
Yes, that makes sense. Would it be reasonable to output That would make it easier for those of us who want to prevent inadvertent publishing of |
I'd vote for keeping it in the output directory ( |
May I try to implement this, or is more review required first? |
If you want to do this, go for it! |
This is now implemented on |
Right now, CI, validation, change tracking, etc. that use tools like
diff
orgit diff
need to go to extra work to explicitly ignore eachundocumented.json
(and the docset.tgz
that contains one), becausesource_directory
causes output differences unrelated to the source code.Also, is it wise to print the user’s username and file structure without notifying them—particularly into documents they are likely to publish? Some might see that as a security risk.
What purpose does
source_directory
currently serve? Is there a more consistent, more secure way of achieving that purpose?The text was updated successfully, but these errors were encountered: