polkadot-js / api

79%

master: 75%

LAST BUILD ON BRANCH luke-154-api-docs-not-render-correctly

branch: luke-154-api-docs-not-render-correctly

CHANGE BRANCH

x

Reset

• luke-154-api-docs-not-render-correctly
• am-codec
• am-constructor-2
• am-docs
• am-encode
• am-encoded-length
• am-events
• am-extrinsics
• am-fix-method
• am-get-argsdef
• am-get-at-index
• am-intermediate-step
• am-json
• am-method
• am-no-from
• am-only-constructor
• am-remove-from
• am-storage
• am-storage-key
• am-u8a
• greenkeeper/@polkadot/dev-0.10.1
• greenkeeper/@polkadot/dev-0.11.1
• greenkeeper/@polkadot/dev-0.15.1
• greenkeeper/@polkadot/dev-0.16.1
• greenkeeper/@polkadot/dev-0.16.10
• greenkeeper/@polkadot/dev-0.16.11
• greenkeeper/@polkadot/dev-0.16.12
• greenkeeper/@polkadot/dev-0.16.13
• greenkeeper/@polkadot/dev-0.16.14
• greenkeeper/@polkadot/dev-0.16.16
• greenkeeper/@polkadot/dev-0.16.17
• greenkeeper/@polkadot/dev-0.16.2
• greenkeeper/@polkadot/dev-0.16.3
• greenkeeper/@polkadot/dev-0.16.4
• greenkeeper/@polkadot/dev-0.16.5
• greenkeeper/@polkadot/dev-0.16.6
• greenkeeper/@polkadot/dev-0.16.7
• greenkeeper/@polkadot/dev-0.16.8
• greenkeeper/@polkadot/dev-0.16.9
• greenkeeper/@polkadot/dev-0.17.1
• greenkeeper/@polkadot/dev-0.18.1
• greenkeeper/@polkadot/dev-0.18.2
• greenkeeper/@polkadot/dev-0.20.20
• greenkeeper/@polkadot/dev-0.20.21
• greenkeeper/@polkadot/dev-0.20.22
• greenkeeper/@polkadot/dev-0.20.23
• greenkeeper/@polkadot/dev-0.20.24
• greenkeeper/@polkadot/dev-0.20.25
• greenkeeper/@polkadot/dev-0.20.26
• greenkeeper/@polkadot/dev-0.21.1
• greenkeeper/@polkadot/dev-0.21.2
• greenkeeper/@polkadot/dev-0.21.3
• greenkeeper/@polkadot/dev-0.4.1
• greenkeeper/@polkadot/dev-0.4.2
• greenkeeper/@polkadot/dev-0.5.2
• greenkeeper/@polkadot/dev-0.6.1
• greenkeeper/@polkadot/dev-0.6.2
• greenkeeper/@polkadot/dev-0.6.3
• greenkeeper/@polkadot/dev-0.7.1
• greenkeeper/@polkadot/dev-0.7.2
• greenkeeper/@polkadot/dev-0.8.1
• greenkeeper/@polkadot/dev-0.9.1
• greenkeeper/@polkadot/ts-0.0.25
• greenkeeper/@polkadot/ts-0.0.26
• greenkeeper/@polkadot/ts-0.0.27
• greenkeeper/@polkadot/ts-0.1.1
• greenkeeper/@polkadot/ts-0.1.28
• greenkeeper/@polkadot/ts-0.1.29
• greenkeeper/@polkadot/ts-0.1.30
• greenkeeper/@polkadot/ts-0.1.31
• greenkeeper/@polkadot/ts-0.1.33
• greenkeeper/@polkadot/ts-pin-0.1.31
• greenkeeper/initial
• greenkeeper/monorepo.babel7-7.1.5
• jg-AccountIndex-from-number
• jg-account
• jg-accountId-lookups
• jg-accountIndex-enumset
• jg-accountIndex-u32
• jg-accountindex-updates
• jg-addr-fixes
• jg-address-from-ss58-id
• jg-am-encode
• jg-api-2
• jg-api-base
• jg-api-docs
• jg-api-examples
• jg-api-fixes
• jg-api-format
• jg-api-isConnected
• jg-api-new
• jg-api-null-storage
• jg-api-observable
• jg-api-observable-query-raw-u8a
• jg-api-observable-watch
• jg-api-promise
• jg-api-provider
• jg-api-pubsub
• jg-api-robust
• jg-arg-check
• jg-author
• jg-auto-hash
• jg-babel-7
• jg-babel-flow
• jg-badges
• jg-balance-defaults
• jg-block-init
• jg-blocknumber-u32
• jg-bool
• jg-bump
• jg-bump-deps
• jg-bumps
• jg-bytes-hex
• jg-bytes-length
• jg-calc-index-old
• jg-callId
• jg-classify-coder
• jg-classify-mock
• jg-classify-providers
• jg-cleanup-u8a
• jg-cleanups
• jg-cleanups-2
• jg-cleanups-3
• jg-code-string-types
• jg-codec
• jg-combinator
• jg-compact
• jg-construct-u8a
• jg-copy
• jg-createfn.toJSON
• jg-decode-accountid-prefix
• jg-decode-fromJSON
• jg-dev
• jg-dev-bump
• jg-digest-seal
• jg-docs-api
• jg-docs-fixes
• jg-docs-ignore
• jg-e2e-extra
• jg-emit-connected
• jg-empty-error
• jg-empty-params
• jg-encode-etx
• jg-engines
• jg-enum-tou8a
• jg-enumset-array
• jg-eslint-jest
• jg-event-export
• jg-event-meta
• jg-event-names
• jg-eventemitter-docs
• jg-eventrecord
• jg-events
• jg-examples-api
• jg-expand-tx-examples
• jg-extra
• jg-extrinsic-decode
• jg-extrinsic-encode
• jg-extrinsic-era-decode
• jg-extrinsic-signedblock
• jg-extrinsics-decode
• jg-fix-callback
• jg-fix-replay-unsub
• jg-fixes
• jg-flow-check
• jg-flow-libs
• jg-flow-lint
• jg-format-output
• jg-format-remove
• jg-fromJSON
• jg-getStorage-coding
• jg-getStorage-mock
• jg-gitbook
• jg-hash-format
• jg-header-number-compact
• jg-id-to-index
• jg-import-export
• jg-jest
• jg-jest-dep
• jg-json-encode-decode
• jg-jsonrpc
• jg-jsonrpc-align
• jg-jsonrpc-submit
• jg-jsonrpc-update
• jg-justification
• jg-justification-decode
• jg-keys-polkadot
• jg-lazy-types
• jg-length
• jg-lerna
• jg-lic-header
• jg-log-events
• jg-logo-base64
• jg-map-subid
• jg-meta-compact
• jg-meta-events
• jg-meta-md
• jg-method-inject
• jg-mock-emitter
• jg-mock-format
• jg-mock-nonceOf
• jg-mock-provider
• jg-mock-publicKey
• jg-mocks-pubsub
• jg-more-types
• jg-move-rpc-json
• jg-no-methodindex
• jg-no-tags
• jg-nojekyll
• jg-npm-publish
• jg-null-undefined
• jg-obs-array-default
• jg-observable-error
• jg-observable-events
• jg-option-empty
• jg-optional-params
• jg-order-on
• jg-pairof
• jg-params
• jg-poc-1-extrinsics
• jg-polkadot-types
• jg-polkadot-util
• jg-primitives-json
• jg-priv-impl
• jg-proposal
• jg-proposal-call
• jg-proposal-length
• jg-propose-e2e
• jg-pub-sub-mock-2
• jg-public-storage
• jg-pubsub
• jg-pubsub-naming
• jg-readme
• jg-readme-fix
• jg-renames
• jg-resub
• jg-revert-params-null
• jg-rpc-types
• jg-runtime-types
• jg-rx-6
• jg-rx-cached-array
• jg-seal-u64
• jg-secure-endpoints
• jg-session-note-offline
• jg-skip-create
• jg-split-interface
• jg-st-bugs
• jg-st-t-query
• jg-staking-methods
• jg-staking-storage
• jg-state-getMeta-opaque
• jg-static-pre-init
• jg-status
• jg-statuscb
• jg-storage
• jg-storage-e2e
• jg-storage-keys
• jg-storage-method-override
• jg-storage-sub
• jg-subid-per-method
• jg-subscribe-catch
• jg-substrate-toJSON
• jg-timestamp-size
• jg-tslint
• jg-tweaks
• jg-type-split
• jg-type-value
• jg-typedef
• jg-types
• jg-types-ext
• jg-types-rpc
• jg-typescript
• jg-update-types
• jg-updates
• jg-upgrades
• jg-util-imports
• jg-util-keyring
• jg-util-to-from
• jg-vector-from-vector
• jg-vector-to-array
• jg-vesting-sched
• jg-voteOf-tuple
• jg-voting-accountIndex
• jg-ws-connect
• jg-ws-reconnect
• jg-ws-subs
• jg-ws-updates
• jg-yarn
• jg-yarn-dev
• jg-year
• js-cleanup-encodeExtrinsic
• js-rx
• luke-117-jsonrpc-methods
• luke-154-api-docs-does-not-render-correctly
• luke-154-api-docs-does-not-render-correctly-coloured-syntax
• luke-168-unable-to-generate-documentation
• luke-193-docs-methods-poc3
• luke-204-coloured-syntax-highlighting-typedoc
• luke-208-httpprovider-example-incorrectly-uses-wsprovider
• luke-210-lack-of-diagrams-in-api-docs
• luke-221-duplicate-tests-build
• luke-235-typedoc-updates-consistent-with-renaming
• luke-239-rename-types-to-rpcrx-prefix
• luke-241-rename-types-to-apirx-prefix
• luke-244-rpcrx-links-broken
• luke-268-logo
• luke-275-fix-readme-outdated-links
• luke-288-sections-methods-not-alphabetic-order
• luke-289-anchor-links-node-interface-pages
• luke-320-remove-generated-files-from-tracking
• luke-323-try-change-to-dev-dependency
• luke-374-remove-fixme
• luke-381-submit-watch-extrinsic-typo
• luke-apps-issue-262-txpool
• luke-fix-examples-promise
• luke-fix-readme
• luke-inputnumber-for-apps-issue-144
• luke-refactor-misc
• luke-refactor-misc-more-examples
• luke-wip1
• master
• revert-70-jg-auto-hash
• yjkimjunior-patch-1

Build # 881

Build Type

Pull #167

travis-ci

Committed by web-flow

Commit Message

docs: Fixes #154

* Move triple backticks onto new line so it doesn't break the code snippet formatting

* Add newline between dependency imports and variable declarations

* Add link to relevant line of Github repo of eventemitter3 instead of the travis build directory

* Add full stop at end of sentence in line before `@example` in .ts files, since I noticed that was the only difference between code snippet in docs that was being rendered correctly and one that was not (if the docs were generated from it). Not sure if this actually makes any difference though, but it doesn't hurt to try. i.e. change `[[unsubscribe]]` to `[[unsubscribe]].`

* Add missing code syntax for `new Ws(defaults.WS_URL)`

* Add missing `*__example__*:`

* Add missing semi-colons throughout code

* Fix typos and some grammar

* Move import of external libraries i.e. `const BN = require('bn.js');` or `const crypto = require('crypto');` before `@polkadot` ones in code

* Change from `e` to `error` in catch blocks for readable documentation

Pull Request Pull Request #167: docs: Fixes #154 API docs not rendering correctly

Run Details

328 of 482 branches covered (68.05%)

Branch coverage included in aggregate %.

1042 of 1244 relevant lines covered (83.76%)

106.23 hits per line