initial/limited inlined comment check support #1099
Merged
Conversation
This file contains hidden or 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
Provides a crude check to warn if a page update will result in the lost of inlined comments on a page. Users can fail a publish attempt in these situations using `--fail-on-warning` [1], if desired. This commit also adds the `confluence_publish_skip_commented_pages` option, to allow skipping page updates on inlined commented pages (instead of overwriting the page). Note that resolved comments are still considered a flagged state for inlined comment. So, a page update will warn even if all comments are resolved. [1]: https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-W Signed-off-by: James Knight <[email protected]>
|
For #698. |
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.
Provides a crude check to warn if a page update will result in the lost of inlined comments on a page. Users can fail a publish attempt in these situations using
--fail-on-warning[1], if desired.This commit also adds the
confluence_publish_skip_commented_pagesoption, to allow skipping page updates on inlined commented pages (instead of overwriting the page).Note that resolved comments are still considered a flagged state for inlined comment. So, a page update will warn even if all comments are resolved.
[1]: https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-W