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

Terminology normalization #2015

Closed
8 tasks done
JJ opened this issue May 9, 2018 · 7 comments
Closed
8 tasks done

Terminology normalization #2015

JJ opened this issue May 9, 2018 · 7 comments
Labels
good first issue If you want to dive in, this would be a good place to start meta RFCs, general discussion, writing style, repository organization, etc.

Comments

@JJ
Copy link
Contributor

JJ commented May 9, 2018

The problem

Looking for handles for some reason I have found that file handle appear at least in that form or in the filehandle form. We should try and normalize terminology across all the documents, and this is only an example. When normalization is done, we should turn it into a test later on.

Suggestions

Agree on one single form for terms that are frequently appearing in the documentation. Please add terms below, and let's discuss in the comments which form is preferred.

  • file handle, filehandle, file-handle → filehandle

  • runtime, run-time → runtime

  • short-hand, shorthand →shorthand

  • look-ahead, lookahead →lookahead

  • look-behind, lookbehind →lookbehind

  • smart-match, smartmatch, smart-matching, smart-matches → smartmatch

  • Add the words to the xt/word-variants.t test

  • Add them to the writing-docs/STYLEGUIDE.md

@JJ JJ added JJ TPF Grant meta RFCs, general discussion, writing style, repository organization, etc. good first issue If you want to dive in, this would be a good place to start labels May 9, 2018
@JJ
Copy link
Contributor Author

JJ commented May 13, 2018

@ufobat I see you have edited this, but could you please indicate the commit where you made that change?

@JJ JJ removed the JJ TPF Grant label May 14, 2018
chsanch added a commit to chsanch/doc that referenced this issue May 21, 2018
This is part of the fixes suggested in Raku#2015
@AlexDaniel
Copy link
Member

“filehandle” is done now, but we need tests.

fluca1978 added a commit that referenced this issue May 22, 2018
chsanch added a commit to chsanch/doc that referenced this issue May 29, 2018
Terms fixed: runtime, shorthand, lookahead, lookbehind
@chsanch
Copy link
Contributor

chsanch commented May 29, 2018

Working on this issue, I've noticed that in the case of "smart-match" there are some other terms related i.e.:
smart-matching
smart-matches

Just to be sure if all of them should be in the form smartmatch*

@rafaelschipiura
Copy link
Contributor

rafaelschipiura commented May 29, 2018

@chsanch You can also add the words you changed to the xt/word-variants.t test.

@rafaelschipiura
Copy link
Contributor

@chsanch You can also add those words to the styleguide: writing-docs/STYLEGUIDE.md

@JJ
Copy link
Contributor Author

JJ commented May 29, 2018 via email

@chsanch
Copy link
Contributor

chsanch commented May 29, 2018

Ok, I'm on it.

rafaelschipiura added a commit that referenced this issue May 29, 2018
Change terms as suggested in #2015
chsanch added a commit to chsanch/doc that referenced this issue May 29, 2018
Change all the smart-match* matches as suggested in Raku#2015
Change xt/word-variants.t to just display the filename an error message when
the test fails
JJ added a commit that referenced this issue May 30, 2018
Refs #2015 and #2041, although they were actually closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue If you want to dive in, this would be a good place to start meta RFCs, general discussion, writing style, repository organization, etc.
Projects
None yet
Development

No branches or pull requests

4 participants