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

chore: Change the title from 'TL;DR' to 'Summary' #2212

Merged
1 commit merged into from May 1, 2019
Merged

chore: Change the title from 'TL;DR' to 'Summary' #2212

1 commit merged into from May 1, 2019

Conversation

ghost
Copy link

@ghost ghost commented Apr 29, 2019

In order to give a good understanding of 'TL;DR', change it to 'Summary' to make it more proper.
Ref: #2210.

@ghost ghost requested review from davisjam and Trott April 29, 2019 00:23
@davisjam
Copy link
Contributor

Do you have a reason to think that "Abstract" is more understandable than "TL;DR" to the average reader?

@stevemao
Copy link
Contributor

I support this change. It makes the title more formal.

@ghost
Copy link
Author

ghost commented Apr 29, 2019

@davisjam:I don't think 'TL;DR' is more formal than 'Abstract', if in a scientific article.

On the other hand, 'TL;DR' may have two meanings:

  1. Too Long Don't Read.
  2. Too Long Didn't Read.

This will make it too puzzled, so to make it "Abstract" just as your suggestion to make it more clear to understand (#2210 (comment)). I think yours is better to understand.

@zeke
Copy link
Contributor

zeke commented Apr 29, 2019

👍 I'm in favor of this change. TLDR is widely known among English-speaking developers, but it's not very accessible to international audiences.

I think "Abstract" is an improvement on TLDR, but "Abstract" is more likely to be recognizable to people with academic backgrounds, and could be confusing to people who don't read research papers.

I would suggest "Summary" as a more universally accessible term.

@davisjam
Copy link
Contributor

davisjam commented Apr 29, 2019

I like "Summary" more as well, for the reasons @zeke outlined.

@ghost
Copy link
Author

ghost commented Apr 30, 2019

@davisjam:OK. Follow your suggestion :)

In order to give a good understanding of 'TL;DR', change it to
'Abstract' to make it more proper.
Ref: #2210.
@ghost ghost changed the title chore: Change the title from 'TL;DR' to 'Abstract' chore: Change the title from 'TL;DR' to 'Summary' Apr 30, 2019
Copy link
Contributor

@zeke zeke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💯

Copy link
Contributor

@davisjam davisjam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ghost ghost merged commit d52ce84 into nodejs:master May 1, 2019
@ghost ghost deleted the ChangeTitle branch May 1, 2019 04:36
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants