Skip to content

Comments

docs: add examples for variable naming#39

Open
leviFrosty wants to merge 1 commit intosilvermine:masterfrom
leviFrosty:add_variable_examples
Open

docs: add examples for variable naming#39
leviFrosty wants to merge 1 commit intosilvermine:masterfrom
leviFrosty:add_variable_examples

Conversation

@leviFrosty
Copy link

Updates coding-standards.md:493-536 to include new example for variable naming based on provided standards for easier visual comprehension.

@onebytegone onebytegone requested a review from yokuze September 22, 2025 12:58

Example:

```javascript
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding this! I think it'll be helpful to have a concise reference for devs to scan.

Could you:

  1. Make the example TypeScript
  2. Format the example according to our ESLint standards

?

Thanks

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be useful to also include an example of an acronym e.g. URL.

@leviFrosty leviFrosty force-pushed the add_variable_examples branch 3 times, most recently from b7195a5 to ea38af7 Compare November 11, 2025 16:17
@leviFrosty
Copy link
Author

I have updated the example to be Typescript. To align better with actual coding problems, I've centered the example around an ApiClient, not just abstract variables. I included some missing examples as well (protected & static methods). I also formatted the document to be aligned with our existing formatting standards. @yokuze

@velocitysystems I've added a naming example using "URL" acronym.

Thanks everyone!

@leviFrosty leviFrosty force-pushed the add_variable_examples branch from ea38af7 to 7e7bcaa Compare November 11, 2025 16:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants