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

manoharreddyporeddy commented 3 years ago

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 commented 3 years ago

Can u assign this to me?

vapier commented 2 months ago

feel free to send a PR for it

SohanRaidev commented 2 weeks ago

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 commented 2 weeks ago

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

google / styleguide

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