esl icon indicating copy to clipboard operation
esl copied to clipboard

[🔨 code style]: replace tense of verbs in TS Docs descriptions

Open abarmina opened this issue 3 years ago • 14 comments

As a member of the ESL dev team, I want to be able to see the use of third-person singular verbs in Present Simple in component TS Doc descriptions.

For example (current state -> proposed state):

  • Create ... -> Creates ...
  • Return ... -> Returns ...
  • etc...

Scope of the issue:

  • [x] esl-alert (src/modules/esl-alert/core/esl-alert.ts)
  • [ ] esl-utils/async - src/modules/esl-utils/async/ in this folder files: delayed-task.ts, raf.ts
  • [ ] esl-utils/decorators - src/modules/esl-utils/decorators/ in this folder files: bind.ts, memoize.ts, ready.ts
  • [ ] esl-utils/dom - src/modules/esl-utils/dom/ in this folder files: api.ts, class.ts, events.ts, ready.ts, rect.ts, rtl.ts, scroll.ts, traversing.ts, window.ts
  • [ ] esl-utils/fixes (src/modules/esl-utils/fixes/ie-fixes.ts)
  • [ ] esl-utils/misc - src/modules/esl-utils/misc/ in this folder files: array.ts, memoize.ts, object.ts, set.ts, uid.ts

We suggest opening separate pull requests for each component or directory.

abarmina avatar Oct 06 '21 17:10 abarmina

@abarmina Can you assign this to me?

Onyinye91-ctrl avatar Oct 07 '21 18:10 Onyinye91-ctrl

Hey @Onyinye91-ctrl, sure, assigned this issue to you. We really appreciate your help with the ESL project!

ala-n avatar Oct 07 '21 18:10 ala-n

Thanks @ala-n but i can't find were to make those changes

Onyinye91-ctrl avatar Oct 08 '21 05:10 Onyinye91-ctrl

Thanks @ala-n but i can't find were to make those changes

Hi @Onyinye91-ctrl! All of these files are located in the src/modules folder. For example, you can find esl-alert in this path - src/modules/esl-alert/core/esl-alert.ts. If necessary, I can add a path to all files.

abarmina avatar Oct 08 '21 07:10 abarmina

@abarmina well Noted. Thanks

Onyinye91-ctrl avatar Oct 08 '21 11:10 Onyinye91-ctrl

@abarmina I should change the following to plural right? ch

Onyinye91-ctrl avatar Oct 08 '21 12:10 Onyinye91-ctrl

@Onyinye91-ctrl, no, only descriptions (comments) need to be changed. For example:

Screenshot 2021-10-08 at 15 34 25 or Screenshot 2021-10-08 at 15 35 34

abarmina avatar Oct 08 '21 13:10 abarmina

Okay @abarmina So I should be looking out for these verbs, create and return only or is there more?

Onyinye91-ctrl avatar Oct 08 '21 13:10 Onyinye91-ctrl

@Onyinye91-ctrl, these can be different verbs, "create" and "return" were just examples. I slightly changed the description, added paths to files. If anything, feel free to ask =) As an option, you can change one file and open a pull request, and we can comment on it if something suddenly goes wrong

abarmina avatar Oct 08 '21 14:10 abarmina

@abarmina Thanks i will do as you suggested

Onyinye91-ctrl avatar Oct 09 '21 11:10 Onyinye91-ctrl

I would like to work on this issue. Would you please assign this to me?

aswiniip avatar Oct 11 '21 19:10 aswiniip

I would like to work on this issue. Would you please assign this to me?

Sandra is currently working on this issue, but we have several files, so we will be glad to add you ,@aswinidev, as a second contributor. Sandra is working on src/modules/esl-alert/core/esl-alert.ts file, and you can choose any other from the list

abarmina avatar Oct 12 '21 13:10 abarmina

@ala-n Can i take another file?

Onyinye91-ctrl avatar Oct 14 '21 09:10 Onyinye91-ctrl

Hey @Onyinye91-ctrl sure, take another file. But please be aware that the maintainer's team (@exadel-inc/esl-core-team) can not spend much time on support with documentation tickets. Please follow our Contribution Guide and be careful in your changes.

ala-n avatar Oct 15 '21 14:10 ala-n