fix: Fixes #154 Modify TypeDocs that change the source to resolve rendering correctly #203
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
…ectly * Add TypeDoc/TSDoc labels * Use HTML <BR> element in TypeDoc to generate new lines even to achieve a newline between lines of code * Use HTML <PRE><CODE> combination in TypeDoc for multiple line code generation * Add missing TypeDocs for HTTP `constructor` and `send` for HTTP and WS * Remove unnecessary assignment of `= true` default value in TypeDoc @param value and clean up text alignment * Verified that it displays correctly in development environment by running `yarn; yarn polkadot-dev-build-docs; yarn gitbook serve`, and then navigating to localhost:4000
jacogr
reviewed
Oct 4, 2018
packages/api/src/index.ts
Outdated
| @@ -46,14 +51,17 @@ export default class Api implements ApiInterface { | |||
|
|
|||
| /** | |||
| * @name signature | |||
| * @signature jsonrpcSignature (method: InterfaceMethodDefinition): string | |||
| * @signature `jsonrpcSignature (method: InterfaceMethodDefinition): string` | |||
There was a problem hiding this comment.
This could be whacked. I actually saw it a day or two ago and then got ditracted. (It was for my lil jsdoc extension that built the docs on flowtype - when it still worked)
There was a problem hiding this comment.
I've pushed commit c9bc957 that removes this line
jacogr
approved these changes
Oct 5, 2018
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
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.
Add TypeDoc/TSDoc labels
Use HTML
element in TypeDoc to generate new lines even to achieve a newline between lines of code
Use HTML
<PRE><CODE>combination in TypeDoc for multiple line code generationAdd missing TypeDocs for HTTP
constructorandsendfor HTTP and WSRemove unnecessary assignment of
= truedefault value in TypeDoc @param value and clean up text alignmentVerified that it displays correctly in development environment by running
yarn; yarn polkadot-dev-build-docs; yarn gitbook serve, and then navigating to localhost:4000