General editing and corrections #187
Conversation
Proofreading, additions, and insertion of internal links through the letter D. Alteration of definitions of argument/parameter, anonymous function, assertion, binary expression, and catch exception.
* Update glossary.yml * Proofreading, additions, and insertion of internal links through the letter D. * General editing of E-O and adding to some definitions. * General editing on remainder of the file.
baileythegreen
changed the title
This reverts commit fcbfafa.
…eral-editing-and-corrections Revert 1 baileythegreen general editing and corrections
There was a problem hiding this comment.
wow! Fantastic work @baileythegreen 😍 I'll let @zkamvar do the final approval and merge but thank you so much for all the improvements your PR brings!
|
Thanks, @fmichonneau! Believe it or not, I actually learned some stuff reading through it, too. (I'm also really glad someone took the time to go through that giant pull request.) |
|
It is maybe worth pointing out that many of the translations appear to be direct translations of the existing English definitions (so errors and the odd opinionated comment are propagated). Ideally where I've made actual corrections, or expanded definitions so that they don't focus on a particular language, the translations could also be updated. (I know that is a time commitment, and I'd be happy to take a stab at it in the case of French and Spanish entries, with the understanding that a native speaker would look over them after. |
Yes, we'd like to build a tool that helps with this issue.
That would be great, and we'd be happy to check these entries. |
There was a problem hiding this comment.
Thank you so much for this contribution! Going through the changes, it looks like it was definitely needed.
In particular, I appreciate the inclusion of more common examples and removing some of the colloquial or snarky language that snuck in there. I've gone through and suggested some changes that fix typos, add context, or revert changes that I felt were not necessary. There are also some questions that I have about a few definitions.
Remove a self-reference to argument on line 428. Co-authored-by: Zhian N. Kamvar <zkamvar@gmail.com>
Increase consistency in how an internal link should be applied to a possessive reference. Co-authored-by: Zhian N. Kamvar <zkamvar@gmail.com>
Add missing internal link. Co-authored-by: Zhian N. Kamvar <zkamvar@gmail.com>
More fixing of possessive internal links. Co-authored-by: Zhian N. Kamvar <zkamvar@gmail.com>
Put in em-dashes in place of colons (or en-dashes). Co-authored-by: Zhian N. Kamvar <zkamvar@gmail.com>
More em-dashes. Co-authored-by: Zhian N. Kamvar <zkamvar@gmail.com>
Clarify that grouping can be done based on one or several fields. Co-authored-by: Zhian N. Kamvar <zkamvar@gmail.com>
Add in missing internal link. Co-authored-by: Zhian N. Kamvar <zkamvar@gmail.com>
Add R to list of languages that allow heterogeneous lists. Co-authored-by: Zhian N. Kamvar <zkamvar@gmail.com>
Change emphasis characters. Co-authored-by: Zhian N. Kamvar <zkamvar@gmail.com>
Revert 'upon' to 'on'. Co-authored-by: Zhian N. Kamvar <zkamvar@gmail.com>
Fix wrong bracket type. Co-authored-by: Zhian N. Kamvar <zkamvar@gmail.com>
Remove extra word. Co-authored-by: Zhian N. Kamvar <zkamvar@gmail.com>
|
Thank you again @baileythegreen for the submission! |
|
@zkamvar Before you consider this 'finished', I think you missed the comments I left last night on the suggestions I didn't close. You've just pulled a version with two entries for 'interpreter', an inaccurate definition of 'k-nearest neighbours', and two other things that I care less about in the REPL and scalar entries. |
Sorry about that. I didn't see any comments on those items and I assumed that they were okay to change. For reference, here are the individual comments, which I have also marked as unresolved: interpreter: #187 (comment) For example, I do not see a comment on K-nearest neighbors beyond my initial suggestion. I get a feeling that GitHub's interface may have let us down here :/
(and yes, I now realize the error I introduced 🤦. I swear I actually can brain most days...) Do you want to create a new PR or just comment on the issue comments? |
|
@zkamvar I can do a separate pull request with those four changes (interpreter, k-nearest neighbours, REPL, and scalar). That will probably be simpler. This one should have been more than one to begin with, and is now quite long and convoluted. I may do this tomorrow as it is quite late here. ps. I am super jealous that you live in Portland. I love it there. |
Note
(I apologise for doing all of this in one pull request, but for general proofreading, the end product comes out much more consistent if it is done all at once. I realised after I finished that the few entries I expanded should be separate. I am happy to create a new branch, copy those changes over, and submit a separate pull request so that they can be reviewed, if that is preferable.)
Pull Request
Proofreading, additions, and insertion of internal links throughout the file. Where statements were incorrect, misleading, or incomplete, I have tried to correct that. (Again, sorry for not doing this separately.) Also some statements that were opinion- rather than fact-based have been removed, as have phrasings that were intended to be humourous, but which may cause undue confusion for non-native speakers, and colloquial phrases.
Author:
Language: English
(Some small changes made to French or Spanish to remove opinionated statements, but these are very few in number, and no new definitions were added in these languages.)
Terms defined:
Editor
Assign the PR based on the language to the following person: