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
Comments
|
@ufobat I see you have edited this, but could you please indicate the commit where you made that change? |
This is part of the fixes suggested in Raku#2015
|
“filehandle” is done now, but we need tests. |
Terms fixed: runtime, shorthand, lookahead, lookbehind
|
Working on this issue, I've noticed that in the case of "smart-match" there are some other terms related i.e.: Just to be sure if all of them should be in the form smartmatch* |
|
@chsanch You can also add the words you changed to the xt/word-variants.t test. |
|
@chsanch You can also add those words to the styleguide: writing-docs/STYLEGUIDE.md |
|
El mar., 29 may. 2018 a las 20:12, Rafael Schipiura (<
notifications@github.com>) escribió:
@chsanch <https://github.com/chsanch> You can also add the words you
changed to the doc/Type/X/IO/DoesNotExist.pod6 test.
You probably mean xt/word-variants.t
|
|
Ok, I'm on it. |
Change terms as suggested in #2015
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
The problem
Looking for
handlesfor some reason I have found that file handle appear at least in that form or in thefilehandleform. 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
The text was updated successfully, but these errors were encountered: