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

Refactor: Documentation Update 4.0.15 #545

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions .babelrc
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
{
"presets": [
"env"
["@babel/preset-env", {
"targets": {
"node": "8.3.0"
}
}]
],
"plugins": [
"transform-regenerator",
"transform-object-rest-spread"
"@babel/plugin-transform-regenerator",
"@babel/plugin-proposal-object-rest-spread"
]
}
13 changes: 11 additions & 2 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
{
"root": true,

"plugins": [
"jsdoc"
"jsdoc",
"mocha"
],

"env": {
Expand All @@ -17,6 +20,7 @@
"plugin:import/errors",
"plugin:import/warnings",
"plugin:lodash/recommended",
"plugin:mocha/recommended",
"plugin:jsdoc/recommended"
],

Expand All @@ -25,11 +29,16 @@
},

"rules": {
"jsdoc/check-tag-names": 0,
"jsdoc/no-undefined-types": 0,
"no-multiple-empty-lines": ["error", { "max": 1, "maxEOF": 1 }],
"promise/no-callback-in-promise": 0,
"lodash/prefer-lodash-method": 0,
"lodash/prefer-noop": 0,
"lodash/prefer-constant": 0,
"node/no-unpublished-require": 0
"node/no-unpublished-require": 0,
"mocha/no-mocha-arrows": 0,
"mocha/no-setup-in-describe": 0,
"mocha/no-skipped-tests": 0
}
}
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,5 @@ coverage/
tags
.undodir
Session.vim
!./docs/jsdoc/.keep
./docs/jsdoc/
53 changes: 0 additions & 53 deletions .istanbul.yml

This file was deleted.

27 changes: 0 additions & 27 deletions .jsdoc.json

This file was deleted.

5 changes: 5 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
4.0.15
- meta: bump deps
- meta: normalize eslint config
- refactor: improve doclets

4.0.14
- fix: README docs reference

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ const ws = new WSv2({ transform: true })

### Docs

Refer to the [`docs/`](https://cdn.statically.io/gh/bitfinexcom/bitfinex-api-node/master/docs/index.html)
folder for JSDoc-generated HTML documentation, and the [`examples/`](/examples)
folder for executable examples covering common use cases.
API documentation can be found in [`docs/reference.md`](docs/reference.md), and
examples in the [`examples`](examples) folder.

Official API documentation at [https://docs.bitfinex.com/v2/reference](https://docs.bitfinex.com/v2/reference)
Complete API documentation can be found at
[docs.bitfinex.com/v2/reference](https://docs.bitfinex.com/v2/reference)

### Examples

Expand Down
Empty file added docs/.keep
Empty file.
Loading