Put the table back in 'table of contents'! #5
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.
Which problem does this PR solve?
As suggested by @alextreppass in realyze#17, it would be nice to support displaying the table of contents in an actual table format.
Main changes
This PR adds a new config option,
prs.toc-format
to the.pr-train.yml
. Valid values aretext
ortable
. Iftable
is set, a format matching what Alex suggested is used for the TOC (Table of Contents) instead. The default value istext
, making this an opt-in feature for now.Related documents/resources
See previous PRs (i.e. realyze#30) for more details about the addition of the
prs
section to the config file.How I tested it works
I tested this in my own test repository. One example.