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

Add description of the abbreviated term "RBS" #1350

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

piroor
Copy link

@piroor piroor commented Jun 10, 2023

I was not familiar to the context of this project so I've been confused what means the project name at the first time. How about adding description about the name "RBS" itself?

@pocke
Copy link
Member

pocke commented Jun 15, 2023

Thanks for your PR!
Right, I think you are still confused because RBS is not an acronym for "RuBy Signature".
ref: #670

I think your proposal will introduce another confusion. How about improving the description with the linked issue?

@piroor
Copy link
Author

piroor commented Jun 15, 2023

Oh, sorry I missed the thread. I've updated the description (added "originated from") and linked to the issue. How about this?

@piroor
Copy link
Author

piroor commented Jun 15, 2023

And I agree it is better way that adding a FAQ topic like some major projects instead of adding to the first description, if there was FAQ list.

README.md Outdated
@@ -1,6 +1,6 @@
# RBS

RBS is a language to describe the structure of Ruby programs.
RBS (*R*u*B*y *S*ignature) is a language to describe the structure of Ruby programs.
Copy link
Contributor

Choose a reason for hiding this comment

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

How about:

Suggested change
RBS (*R*u*B*y *S*ignature) is a language to describe the structure of Ruby programs.
RBS (`.rb` *s*ignature) is a language to describe the structure of Ruby programs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants