fix: Sphinx generated incorrect type references for display #232
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
RomainMuller
force-pushed
the
rmuller/fix-sphinx-warnings
branch
from
4bed159
to
01343bf
Compare
eladb
approved these changes
Sep 17, 2018
When rendering a type reference link, the trailing backtick must be followed by a non-word character; however the code generated array and union references that followed this backtick directly with `[` or `)` respectively. This caused a lot of warnings to be emitted by `sphinx-build`, and resulted in incorrect output. This adds an escaped space (`\ `) after the backticks, which `sphinx-build` correctly interprets as a non-word character, but results in no character being emitted to the output - thus generating the desired output.
RomainMuller
force-pushed
the
rmuller/fix-sphinx-warnings
branch
from
01343bf
to
6980b97
Compare
eladb
pushed a commit
that referenced
this pull request
Sep 20, 2018
Bug Fixes ====================== * Sphinx generated incorrect type references for display ([#232](#232)) ([b664805](b664805)) * **jsii:** Defaulted parameters were not rendered as optional ([#234](#234)) ([578bf9c](578bf9c)), closes [#233](#233) * **jsii:** Don't skip emit on TS errors when in "watch" mode ([#236](#236)) ([30d1491](30d1491)), closes [#235](#235) * **jsii:** Optional `any` represented as required ([#237](#237)) ([91074f3](91074f3)), closes [#230](#230) Features ====================== * **sphinx:** allow readme file to define sphinx header and reorganize topic ([#229](#229)) ([405da9c](405da9c)), closes [#228](#228) [#185](#185) * Document overriden/inherited members ([#238](#238)) ([7a6278a](7a6278a)), closes [#196](#196)
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.
When rendering a type reference link, the trailing backtick must be followed by
a non-word character; however the code generated array and union references that
followed this backtick directly with
[or)respectively. This caused a lotof warnings to be emitted by
sphinx-build, and resulted in incorrect output.This adds an escaped space (
\) after the backticks, whichsphinx-buildcorrectly interprets as a non-word character, but results in no character being
emitted to the output - thus generating the desired output.