code-block: Fix handling of :dedent: and add unit tests #9661
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
Due to how Python converts ints to bool the numeric argument ``0`` to the :dedent: option of the code-block directive was handled like if no argument was given to :dedent:. Check properly for None in the options argument processing, so ``0`` is treated as numeric argument to :dedent:. Bug: sphinx-doc#9636
If the option :dedent: (without numeric argument) was given to code-block then all newlines where striped from the resulting code. Preserve newlines when stripping common whitespace at the beginning of code blocks.
tk0miya
requested changes
Sep 23, 2021
The presence or absence of the ``:dedent: 4`` option in the example
.. code-block:: ruby
:dedent: 4
some ruby code
makes no difference for the output due to how ReST handles whitespace.
If it is present, then ReST indent is 3 and the 4 spaces of the code are
stripped by the :dedent: option. If the dedent option is missing, then
the ReST indent is 7 and all whitespace is stripped again.
Add a dummy option to fixate the ReST indent to 3, so adding and
removing of the option in the example has an effect on the output.
latosha-maltba
force-pushed
the
dedent
branch
from
7a9d721
to
54b1991
Compare
`:dedent: 0` option for the code-block directive is a secret feature. So it should not be mentioned in our docs.
tk0miya
approved these changes
Jan 15, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Subject: code-block: Fix handling of :dedent: and add unit tests
Feature or Bugfix
Depending on the point of view this is one or a combination of:
Purpose
0to dedent is handled as numeric argument and not as "no argument".Relates
:dedent: 0not respected and :dedent: without argument seems broken #9636