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

readline docs: adding events link #8475

Closed
wants to merge 2 commits into
base: master
from

Conversation

Projects
None yet
7 participants
@italoacasas
Member

italoacasas commented Sep 10, 2016

Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)
  • doc
Description of change

I add two missing links to the readline documentation

@mscdex

This comment has been minimized.

Show comment
Hide comment
@mscdex

mscdex Sep 10, 2016

Contributor

If you want, there are a couple of typos in that document that need to be fixed too (SIGSTP -> SIGTSTP and SIGTSPT -> SIGTSTP).

Contributor

mscdex commented Sep 10, 2016

If you want, there are a couple of typos in that document that need to be fixed too (SIGSTP -> SIGTSTP and SIGTSPT -> SIGTSTP).

@mscdex

This comment has been minimized.

Show comment
Hide comment
@mscdex

mscdex Sep 10, 2016

Contributor

LGTM

Contributor

mscdex commented Sep 10, 2016

LGTM

@lpinca

This comment has been minimized.

Show comment
Hide comment
@lpinca

lpinca Sep 10, 2016

Member

Commit message does not follow commit guidelines.
I think something like "doc: link SIGTSTP / SIGCONT events in readline doc" should work.
@italoacasas can you please update it? Thanks!

Member

lpinca commented Sep 10, 2016

Commit message does not follow commit guidelines.
I think something like "doc: link SIGTSTP / SIGCONT events in readline doc" should work.
@italoacasas can you please update it? Thanks!

@addaleax

View changes

Show outdated Hide outdated doc/api/readline.md
@@ -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][])

This comment has been minimized.

@addaleax

addaleax Sep 10, 2016

Member

Hm, these should probably keep their ```? I think the signal names are marked as code everywhere else here.

@addaleax

addaleax Sep 10, 2016

Member

Hm, these should probably keep their ```? I think the signal names are marked as code everywhere else here.

This comment has been minimized.

@italoacasas

italoacasas Sep 10, 2016

Member

@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.

@italoacasas

italoacasas Sep 10, 2016

Member

@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.

This comment has been minimized.

@addaleax

addaleax Sep 10, 2016

Member

@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!

@addaleax

addaleax Sep 10, 2016

Member

@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!

This comment has been minimized.

@italoacasas

italoacasas Sep 10, 2016

Member

😳 my bad. I was the one who did not understand you, it was clear what you meant in the first comment.

@italoacasas

italoacasas Sep 10, 2016

Member

😳 my bad. I was the one who did not understand you, it was clear what you meant in the first comment.

@jasnell

This comment has been minimized.

Show comment
Hide comment
@jasnell

jasnell Sep 12, 2016

Member

LGTM

Member

jasnell commented Sep 12, 2016

LGTM

@lpinca

This comment has been minimized.

Show comment
Hide comment
@lpinca

lpinca Sep 12, 2016

Member

LGTM

Member

lpinca commented Sep 12, 2016

LGTM

lpinca added a commit that referenced this pull request Sep 13, 2016

doc: link SIGTSTP / SIGCONT events in readline doc
PR-URL: #8475
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@lpinca

This comment has been minimized.

Show comment
Hide comment
@lpinca

lpinca Sep 13, 2016

Member

Landed in 53178f9, thanks!

Member

lpinca commented Sep 13, 2016

Landed in 53178f9, thanks!

@lpinca lpinca closed this Sep 13, 2016

Fishrock123 added a commit that referenced this pull request Sep 14, 2016

doc: link SIGTSTP / SIGCONT events in readline doc
PR-URL: #8475
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment