feat: make addition of ToC idempotent #74
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
lukany
force-pushed
the
feat/make-toc-add-idempotent
branch
from
9c6ae29 to
c85a86c
Compare
By design it was possible to add table of contents multiple times. The rendered report then contained multiple table of contents. Having a separate argument for table of contents instead of having it in sections list makes multiple calls of add_table_of_contents() idempotent — always only one ToC is rendered in the end.
lukany
force-pushed
the
feat/make-toc-add-idempotent
branch
from
c85a86c to
a05f85c
Compare
mbelak-dtml
requested changes
Aug 10, 2023
There was a problem hiding this comment.
Nice PR! Made me think that TableOfContents should not actually even be an instance of Section, since the show method breaks the inheritance contract anyway (has a different argument). This PR would also make it easier to change in the future.
EDIT: Created an issue to remove the inheritance #79.
Just 1 minor comment (applies to 2 places).
mbelak-dtml
approved these changes
Aug 11, 2023
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.
By design it was possible to add table of contents multiple times.
The rendered report then contained multiple table of contents.
Having a separate argument for table of contents instead of having
it in sections list makes multiple calls of add_table_of_contents()
idempotent — always only one ToC is rendered in the end.