Section title out of sequence warnings may be generated when using operation macro #628
Conversation
Renderings with standard section depth first to avoid warnings that document starts with level 3 headings. Adjust block level when adding the content to the parent.
| def write_title(content, snippet, level, id, snippet_titles) | ||
| section_level = '=' * (level + 1) | ||
| def write_title(content, snippet, id, snippet_titles) | ||
| section_level = '==' |
There was a problem hiding this comment.
Switch to hardcoding two = feels like it may cause a regression to me. For example, will it not now be wrong if the macro is used in a deeply nested section?
There was a problem hiding this comment.
The new line 53 will adjust the level of all top level blocks the moment they are inserted. This avoid the warning that would otherwise occur when starting with a section of a too high level, and avoid having a regression.
|
I am using this patch and it is working for me. I would be happy to see it in milestone 2.0.4.RELEASE along with #581 solved. |
wilkinsona
added
type: bug
wilkinsona
changed the title
Renderings with standard section depth first to avoid warnings that document starts with level 3 headings. Adjust block level when adding the content to the parent. See gh-628
|
Thanks for the PR, @ahus1. The proposed changes are now in master along with a polishing commit that updated the tests to cover the scenario that previously generated a warning. |
I've run the sample rest-notes-spring-hateoas locally using
gradlew asciidoctorand saw that it generated lots of error messages likeI traced this down to
operation_block_macro.rband changed it so that the block level is adjusted afterAsciidoctor.loadwhen the blocks are added to the parent. I assume this is safe when there are no nested blocks.Once I change it, the output is still correct and the warning message is gone.