readline docs: adding events link #8475
Conversation
nodejs-github-bot
added
doc
|
If you want, there are a couple of typos in that document that need to be fixed too ( |
|
LGTM |
|
Commit message does not follow commit guidelines. |
| @@ -90,7 +90,7 @@ The `'pause'` event is emitted when one of the following occur: | |||
|
|
|||
| * The `input` stream is paused. | |||
| * The `input` stream is not paused and receives the `SIGCONT` event. (See | |||
| events `SIGTSTP` and `SIGCONT`) | |||
| events [SIGTSTP][] and [SIGCONT][]) | |||
There was a problem hiding this comment.
Hm, these should probably keep their ```? I think the signal names are marked as code everywhere else here.
There was a problem hiding this comment.
@addaleax as a reader, I do not know when I'm reading the pause event where the other events are placed, but for some reason, the documentation tells me that they are related, I feel like we can improve the UX adding links instead ``. We are just adding a shortcut.
There was a problem hiding this comment.
@italoacasas Maybe I’m misunderstanding you, but what I mean is that they should be links and code blocks, i.e. [SIGTSTP][] and [SIGCONT][] (and at the bottom of the file [SIGTSTP]: readline.html#readline_event_sigtstp, too). I’m totally agreeing that adding links makes sense here!
There was a problem hiding this comment.
😳 my bad. I was the one who did not understand you, it was clear what you meant in the first comment.
|
LGTM |
1 similar comment
|
LGTM |
PR-URL: #8475 Reviewed-By: Brian White <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
|
Landed in 53178f9, thanks! |
PR-URL: #8475 Reviewed-By: Brian White <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
Checklist
Affected core subsystem(s)
Description of change
I add two missing links to the
readlinedocumentation