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.

Sign up for GitHub

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

Jump to bottom

jsguide: Convert to Simple English - Avoid unfamiliar words: Bandersnatch, FRUMIOUS #596

Open
manoharreddyporeddy opened this issue Nov 11, 2020 · 4 comments · May be fixed by #849
Open

jsguide: Convert to Simple English - Avoid unfamiliar words: Bandersnatch, FRUMIOUS #596

manoharreddyporeddy opened this issue Nov 11, 2020 · 4 comments · May be fixed by #849
Labels
enhancement help wanted lang:js The JavaScript language

Comments

@manoharreddyporeddy
Copy link

https://google.github.io/styleguide/jsguide.html#jsdoc-enum-and-typedef-comments

const BandersnatchType = {
  /** This kind is really frumious. */
  FRUMIOUS: 'frumious',
  /** The less-frumious kind. */
  MANXOME: 'manxome',
};

  • Avoid unfamiliar words to readers

  • This document talks about not using unfamiliar things to readers, however reader is not familized with below words:

      Bandersnatch
  FRUMIOUS
  MANXOME

  • As this is Open Source contibution used by all in the world, can we have Simple English words like Fruits, Apple, Orange?
@omkar342
Copy link

Can u assign this to me?

@vapier vapier changed the title Convert to Simple English - Avoid unfamiliar words: Bandersnatch, FRUMIOUS jsguide: Convert to Simple English - Avoid unfamiliar words: Bandersnatch, FRUMIOUS Jul 3, 2024
@vapier
Copy link
Member

vapier commented Jul 3, 2024

feel free to send a PR for it

@vapier vapier added the lang:js The JavaScript language label Jul 8, 2024
@SohanRaidev
Copy link

Hey It says "Please note: This guide is no longer being updated. Google recommends migrating to TypeScript, and following the TypeScript guide". Can I still send PR for this issue?

@SohanRaidev SohanRaidev linked a pull request Aug 24, 2024 that will close this issue
Open
@SohanRaidev
Copy link

Hey @vapier, I've submitted a PR to address the issue. Unfamiliar terms have been replaced with simpler ones. Could you review it? Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement help wanted lang:js The JavaScript language
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Replaced unfamiliar words with simpler alternatives in the jsguide. SohanRaidev/styleguide
4 participants
@vapier @manoharreddyporeddy @omkar342 @SohanRaidev