Vse Mozhet Byt
7588ceaf35
doc: add more missing backticks
...
Also, fix some other nits in passing
(formatting, punctuation, typos, redundancy, obsoleteness).
PR-URL: https://github.com/nodejs/node/pull/20438
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2018-05-03 02:12:07 +03:00
Vse Mozhet Byt
392d80a617
doc: add missing periods or colons
...
Some other formatting nits were fixed
and some superfluous descriptions were simplified in passing.
PR-URL: https://github.com/nodejs/node/pull/20401
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de >
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2018-05-02 06:17:08 +03:00
Vse Mozhet Byt
a3bd06a5e6
doc: remove redundant empty lines
...
PR-URL: https://github.com/nodejs/node/pull/20398
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com >
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de >
2018-04-29 17:48:43 +03:00
Vse Mozhet Byt
9c8857d946
doc: add quotes for event names + fix similar nits
...
PR-URL: https://github.com/nodejs/node/pull/19915
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
2018-04-11 21:42:38 -07:00
Vse Mozhet Byt
de0053cc32
doc: fix various nits
...
* Replace 2 hyphens (--) by spaced m-dashes (—) as per STYLE_GUIDE.md.
* Space infix operators.
* Unify quotes in inline code spans (use only single quotes).
* Unify `* Returns:` (eliminate deviations).
* Dedupe spaces.
PR-URL: https://github.com/nodejs/node/pull/19743
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
2018-04-04 13:45:39 +03:00
Vse Mozhet Byt
237cbe10fb
doc,tools: formalize, unify, codify default values
...
PR-URL: https://github.com/nodejs/node/pull/19737
Reviewed-By: Gus Caplan <me@gus.host >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
2018-04-04 12:30:36 +03:00
estrada9166
a29089d7c8
doc: add new documentation lint rule
...
Add 80 characters limit to docs.
Change docs to fit 80 characters per row.
PR-URL: https://github.com/nodejs/node/pull/18726
Fixes: https://github.com/nodejs/node/issues/18703
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de >
Reviewed-By: Matteo Collina <matteo.collina@gmail.com >
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com >
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com >
2018-02-23 16:26:29 +00:00
Rich Trott
9cb96ac828
doc: remove extraneous "for example" text
...
No need to announce obvious example code as being example code. Remove
unneeded "for example" text as one small way to try to keep the docs
more concise..
PR-URL: https://github.com/nodejs/node/pull/18890
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Matheus Marchini <matheus@sthima.com >
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de >
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com >
2018-02-23 02:53:21 +02:00
James M Snell
d3569b623c
doc: remove **Note:** tags
...
Remove the various **Note:** prefixes throughout the docs.
PR-URL: https://github.com/nodejs/node/pull/18592
Reviewed-By: Rich Trott <rtrott@gmail.com >
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de >
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com >
2018-02-08 11:57:14 -05:00
Vse Mozhet Byt
fd3a0cfb7c
doc: linkify missing types
...
Also, alphabetize all types in type-parser.js
and fix some nits in type formats.
PR-URL: https://github.com/nodejs/node/pull/18444
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2018-02-01 02:52:31 +02:00
Rich Trott
c6bee70eec
doc: simplify sentences that use "considered"
...
Change many instances of "x is considered to be y" to "x is y".
PR-URL: https://github.com/nodejs/node/pull/18095
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com >
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Richard Lau <riclau@uk.ibm.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
2018-01-17 21:22:53 -08:00
Matej Krajčovič
571c04b07a
doc: make default values and periods consistent
...
PR-URL: https://github.com/nodejs/node/pull/16563
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com >
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2017-10-30 11:08:47 +01:00
Vse Mozhet Byt
e2cddbb8cc
doc: clarify using crlfDelay with fs streams
...
PR-URL: https://github.com/nodejs/node/pull/16259
Fixes: https://github.com/nodejs/node/issues/16077
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
2017-10-19 02:15:13 +03:00
Vse Mozhet Byt
b0c5f7d24d
doc: add history for readline crlfDelay option
...
PR-URL: https://github.com/nodejs/node/pull/16075
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com >
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
2017-10-11 02:03:23 +03:00
Oblosys
8bd1668ca5
doc: fix emitKeypressEvents stream type
...
PR-URL: https://github.com/nodejs/node/pull/15399
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2017-09-15 09:40:20 -07:00
Chris Young
cacce304cb
doc: add links to alternative versions of doc
...
Each page of the API documentation should have links to other versions
of the same page. This will make it easier to switch between the current
"live" release at nodejs.org and LTS versions.
PR-URL: https://github.com/nodejs/node/pull/10958
Fixes: https://github.com/nodejs/node/issues/10726
Reviewed-By: Refael Ackermann <refack@gmail.com >
Reviewed-By: Evan Lucas <evanlucas@me.com >
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com >
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de >
2017-08-28 11:17:08 +02:00
Azard
b8e0a5ea23
readline: remove max limit of crlfDelay
...
PR-URL: https://github.com/nodejs/node/pull/13497
Reviewed-By: Prince John Wesley <princejohnwesley@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Refael Ackermann <refack@gmail.com >
2017-07-31 23:03:18 +02:00
Samuel Reed
ac3477971f
doc: add readline.emitKeypressEvents note
...
PR-URL: https://github.com/nodejs/node/pull/9447
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com >
2017-06-10 19:16:57 +02:00
Vse Mozhet Byt
de411a471e
doc: unify spaces in object literals
...
PR-URL: https://github.com/nodejs/node/pull/13354
Reviewed-By: Timothy Gu <timothygu99@gmail.com >
Reviewed-By: Refael Ackermann <refack@gmail.com >
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com >
Reviewed-By: Tobias Nießen <tniessen@tnie.de >
Reviewed-By: James M Snell <jasnell@gmail.com >
2017-06-03 01:56:19 +03:00
Alexey Orlenko
2af49b6c89
doc: make the style of notes consistent
...
Make the style of "Note:" paragraphs consistent and document the
guidelines in `doc/STYLE_GUIDE.md`.
PR-URL: https://github.com/nodejs/node/pull/13133
Fixes: https://github.com/nodejs/node/issues/13131
Reviewed-By: Refael Ackermann <refack@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com >
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Sam Roberts <vieuxtech@gmail.com >
2017-05-25 18:49:41 -04:00
Sam Roberts
ea1b8a5cbc
doc: sort bottom-of-file markdown links
...
PR-URL: https://github.com/nodejs/node/pull/12726
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com >
2017-05-08 09:30:55 -07:00
Vse Mozhet Byt
35d2137715
doc: modernize and fix code examples in repl.md
...
* Improve UX in 2 code examples (add spaces between output and input
for better readability).
* Replace indexOf() by startsWith().
PR-URL: https://github.com/nodejs/node/pull/12634
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com >
2017-04-27 01:42:57 +03:00
Vse Mozhet Byt
20987752a2
doc: fix an unclear wording in readline.md
...
PR-URL: https://github.com/nodejs/node/pull/12605
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2017-04-25 22:11:41 +03:00
Vse Mozhet Byt
b4fea2a3d6
doc: add eslint-plugin-markdown
...
* install eslint-plugin-markdown
* add doc/.eslintrc.yaml
* add `<!-- eslint-disable rule -->` or `<!-- eslint-disable -->`
for the rest of problematic code
* .js files in doc folder added to .eslintignore
* update Makefile and vcbuild.bat
PR-URL: https://github.com/nodejs/node/pull/12563
Refs: https://github.com/nodejs/node/pull/12557#issuecomment-296015032
Reviewed-By: Teddy Katz <teddy.katz@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Timothy Gu <timothygu99@gmail.com >
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com >
Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com >
2017-04-25 00:06:17 +03:00
Vse Mozhet Byt
e2c3e4727d
doc: conform to rules for eslint-plugin-markdown
...
PR-URL: https://github.com/nodejs/node/pull/12563
Refs: https://github.com/nodejs/node/pull/12557#issuecomment-296015032
Reviewed-By: Teddy Katz <teddy.katz@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Timothy Gu <timothygu99@gmail.com >
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com >
Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com >
2017-04-25 00:06:00 +03:00
Danny Nemer
c8eec76c5f
readline: rename deDupeHistory option
...
Renames `options.deDupeHistory` → `options.removeHistoryDuplicates` for
`readline.createInterface(options)`.
The option name `removeHistoryDuplicates` is preferable to the
semantically identical name `deDupeHistory` because "dedupe" (short for
"deduplication") is obscure and neologistic while
`removeHistoryDuplicates` is clear, though verbose.
Updates tests and documentation for this option accordingly.
PR-URL: https://github.com/nodejs/node/pull/11950
Ref: https://github.com/nodejs/node/pull/2982
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com >
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Evan Lucas <evanlucas@me.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2017-03-22 08:56:24 -07:00
Danny Nemer
5bda5faffd
readline: add option to stop duplicates in history
...
Adds `options.deDupeHistory` for `readline.createInterface(options)`. If
`options.deDupeHistory` is `true`, when a new input line being added to
the history list duplicates an older one, removes the older line from
the list. Defaults to `false`.
Many users would appreciate this option, as it is a common setting in
shells. This option certainly should not be default behavior, as it
would be problematic in applications such as the `repl`, which inherits
from the readline `Interface`.
Extends documentation to reflect this API addition.
Adds tests for when `options.deDupeHistory` is truthy, and when
`options.deDupeHistory` is falsey.
PR-URL: https://github.com/nodejs/node/pull/2982
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
2017-03-17 17:01:32 -04:00
Roman Reiss
ff1361957d
doc: consistent case for primitive types
...
PR-URL: https://github.com/nodejs/node/pull/11167
Reviewed-By: Timothy Gu <timothygu99@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com >
2017-03-02 17:55:45 +01:00
Sebastian Van Sande
e1c8afb0a9
doc: link to readable and writeable stream section
...
Modify the `[Writable]` and `[Readable]` links so they point
directly to the right sections in the stream.html doc
PR-URL: https://github.com/nodejs/node/pull/11517
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Timothy Gu <timothygu99@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
2017-02-27 12:24:36 -08:00
Karan Thakkar
6ae159fa35
doc: change broken fg(1) links to fg(1p)
...
The fg(1) links in the readline docs have moved
from `http://man7.org/linux/man-pages/man1/fg.1.html `
to `http://man7.org/linux/man-pages/man1/fg.1p.html `.
It also modifies the regex for replacing man page links
in docs by allowing optional character after number.
eg: fg(1) and fg(1p) will both be now parsed and replaced.
Fixes: https://github.com/nodejs/node/issues/11492
PR-URL: https://github.com/nodejs/node/pull/11504
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
2017-02-24 02:43:25 +01:00
Anna Henningsen
d9c3a27565
doc: add changelogs for readline
...
PR-URL: https://github.com/nodejs/node/pull/11489
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: Sam Roberts <vieuxtech@gmail.com >
Reviewed-By: Roman Reiss <me@silverwind.io >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Italo A. Casas <me@italoacasas.com >
2017-02-24 02:06:31 +01:00
Anna Henningsen
8a6b37bc51
doc: remove backtick escaping for manpage refs
...
Removing backticks will make the doctool emit links to the man pages.
PR-URL: https://github.com/nodejs/node/pull/9632
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Michaël Zasso <targos@protonmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
2016-11-20 00:56:25 +01:00
Vse Mozhet Byt
45279947f1
doc: small improvements in readline code examples
...
1. Consistent template literals in `console.log()`.
2. === instead of ==.
3. const instead of var.
PR-URL: https://github.com/nodejs/node/pull/9628
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Michaël Zasso <targos@protonmail.com >
Reviewed-By: Jackson Tian <shyvo1987@gmail.com >
2016-11-19 18:05:53 +01:00
Italo A. Casas
3c23db4d8a
doc: remove duplicate content from readline doc
...
Remove a duplicate sentence from the `rl.close()` method description.
PR-URL: https://github.com/nodejs/node/pull/8497
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Prince John Wesley <princejohnwesley@gmail.com >
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2016-09-15 08:31:09 +02:00
Italo A. Casas
53178f908f
doc: link SIGTSTP / SIGCONT events in readline doc
...
PR-URL: https://github.com/nodejs/node/pull/8475
Reviewed-By: Brian White <mscdex@mscdex.net >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
2016-09-13 12:53:17 +02:00
Prince J Wesley
a634554fca
readline: key interval delay for \r & \n
...
Emit two line events when there is a delay between
CR('\r') and LF('\n').
Introduced a new option `crlfDelay`. If the delay between \r and \n
exceeds `crlfDelay` milliseconds, both \r and \n will be treated as
separate end-of-line input. Default to 100 milliseconds.
`crlfDelay` will be coerced to [100, 2000] range.
PR-URL: https://github.com/nodejs/node/pull/8109
Reviewed-By: Yorkie Liu <yorkiefixer@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Brian White <mscdex@mscdex.net >
2016-09-08 20:16:39 +05:30
James M Snell
61fa50d298
doc: readline write() is processed as input
...
Fixes: https://github.com/nodejs/node/issues/4402
PR-URL: https://github.com/nodejs/node/pull/8295
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2016-08-29 15:29:59 -07:00
Anna Henningsen
c809b88345
doc: use blockquotes for Stability: markers
...
Use blockquotes instead of code blocks for stability markers in
the docs. Doing that:
- Makes the makers appear correctly when viewed e.g. on github.
- Allows remark-lint rules like `no-undefined-references` to work
properly (https://github.com/nodejs/node/pull/7729 ).
PR-URL: https://github.com/nodejs/node/pull/7757
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com >
Reviewed-By: Michaël Zasso <mic.besace@gmail.com >
Reviewed-By: Roman Reiss <me@silverwind.io >
2016-08-04 22:43:34 +02:00
saadq
28d9485c25
doc: fix inconsistencies in code style
...
Adds missing semicolons, removes extra white space, and properly indents
various code snippets in the documentation.
Reviewed-By: Evan Lucas <evanlucas@me.com >
Reviewed-By: targos - Michaël Zasso <mic.besace@gmail.com >
PR-URL: https://github.com/nodejs/node/pull/7745
2016-07-15 13:51:58 -04:00
Evan Lucas
3f5623dd46
readline: allow passing prompt to constructor
...
Previously, one would have to call setPrompt after calling
rl.createInterface. Now, the prompt string can be set by passing the
prompt property.
PR-URL: https://github.com/nodejs/node/pull/7125
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
2016-06-25 12:10:28 -05:00
James M Snell
d9e0d8b810
doc: fix minor nit introduced in readline.md
...
PR-URL: https://github.com/nodejs/node/pull/7198
Reviewed-By: Julian Duque <julianduquej@gmail.com >
Reviewed-By: Anna Henningsen <anna@addaleax.net >
2016-06-07 18:55:32 -04:00
James M Snell
c300ba2212
doc: clarify rl.question callback args
...
Clarify that readline's rl.question() callback does not
use the err back pattern.
Fixes: https://github.com/nodejs/node/issues/4833
PR-URL: https://github.com/nodejs/node/pull/7022
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com >
2016-06-07 07:15:14 -07:00
James M Snell
ed8b600b98
doc: general improvements to readline.md copy
...
PR-URL: https://github.com/nodejs/node/pull/7022
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com >
2016-06-07 07:15:09 -07:00
Julian Duque
0ed4d8c535
doc: add added: information for readline
...
Got the information from git history, I added the version when Interface
was exported as class (v0.1.104), it was an internal class on previous
versions.
Refs: https://github.com/nodejs/node/issues/6578
PR-URL: https://github.com/nodejs/node/pull/6996
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-06-06 09:11:14 -07:00
Arve Seljebu
1ba5a56f49
doc: readline.emitKeypressEvents and raw mode
...
`readline.emitKeypressEvents` needs `stream` to be in raw mode.
PR-URL: https://github.com/nodejs/node/pull/6628
Fixes: https://github.com/nodejs/node/issues/6626
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Roman Klauke <romaaan.git@gmail.com >
2016-05-16 16:01:57 +02:00
Eugene Obrezkov
ae178838eb
repl: copying tabs shouldn't trigger completion
...
PR-URL: https://github.com/nodejs/node/pull/5958
Fixes: https://github.com/nodejs/node/issues/5954
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
2016-05-13 17:18:40 +02:00
vsemozhetbyt
563c9f8687
doc: extra clarification of historySize option
...
History caching in the `readline` io is active only for terminal
interaction. Appropriate variables are initialized and relevant
`_addHistory()` function is called only if exposed `terminal` option
of `readline.createInterface()` is set `true` by user or internal
output check.
This clarification is useful to assure users there will be now wasted
overhead connected with history caching if `readline` is used not
for terminal interaction (e.g. for reading files line by line).
Particularly this fix is helpful after #6352 landing.
PR-URL: https://github.com/nodejs/node/pull/6397
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Alexander Makarenko <estliberitas@gmail.com >
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com >
2016-05-01 14:33:28 -07:00
surya panikkal
0303a2552e
readline: allow history to be disabled
...
1. The `historySize` to default to `30` only if `undefined`.
2. If `historySize` is set to 0, then disable caching the line.
3. Added unit tests.
4. Updated documentation.
Fixes: https://github.com/nodejs/node/issues/6336
PR-URL: https://github.com/nodejs/node/pull/6352
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2016-04-26 02:31:05 +02:00
Robert Jefe Lindstaedt
0800c0aa72
doc: git mv to .md
...
* doc: rename .markdown references in content
* doc: rename to .md in tools
* doc: rename to .md in CONTRIBUTING.md
PR-URL: https://github.com/nodejs/node/pull/4747
Reviewed-By: Myles Borins <myles.borins@gmail.com >
Reviewed-By: techjeffharris
Reviewed-By: Johan Bergström <bugs@bergstroem.nu >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Anna Henningsen <anna@addaleax.net >
2016-04-20 16:34:27 -07:00
Ben Noordhuis
d5c95f02af
docs: rename readline.md to readline.markdown
2011-08-08 00:56:04 +02:00