Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Sphinx generated incorrect type references for display #232

Merged
merged 1 commit into from
Sep 17, 2018

Conversation

RomainMuller
Copy link
Contributor

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.

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 RomainMuller merged commit b664805 into master Sep 17, 2018
@RomainMuller RomainMuller deleted the rmuller/fix-sphinx-warnings branch September 17, 2018 14:45
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants