[go: up one dir, main page]
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

API naming conventions should be documented #536

Open
gibson042 opened this issue Feb 11, 2021 · 2 comments
Open

API naming conventions should be documented #536

gibson042 opened this issue Feb 11, 2021 · 2 comments
Assignees
@ben-allen
Labels
c: meta Component: intl-wide issues editorial Involves an editorial fix s: help wanted Status: help wanted; needs proposal champion
Milestone
ES 2025

Comments

@gibson042
Copy link
Contributor

We should explicitly document naming conventions, and maintain them by evaluating new proposals against them.

  • Property names and values should avoid abbreviations.
    • Good examples: "fractionalSeconds", "minimumSignificantDigits"
  • Property names and values that are compound words should combine them using camelCase.
    • Good examples: "signDisplay", "exceptZero"
    • Exception: for values only, nonzero numbers should be expressed as digits (as in "h23")
    • Historical exceptions: "2-digit", "best fit"
  • [open question about "[...]style" vs. "[...]display" for naming high-level configuration properties]
@sffc
Copy link
Contributor
sffc commented Feb 11, 2021

Yes. We have a start in https://github.com/tc39/ecma402/blob/master/docs/style-guide.md, and we should expand that document to cover additional conventions.

@sffc sffc added c: meta Component: intl-wide issues editorial Involves an editorial fix s: help wanted Status: help wanted; needs proposal champion labels Feb 11, 2021
@sffc sffc added this to the ES 2021 milestone Feb 11, 2021
@sffc sffc modified the milestones: ES 2021, ES 2022 Mar 22, 2021
@sffc sffc modified the milestones: ES 2022, ES 2023 Jun 1, 2022
@sffc
Copy link
Contributor
sffc commented Sep 18, 2023

@ben-allen to make a PR adding more of the content from the OP in time to discuss at the October TG2 meeting.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ben-allen ben-allen

Labels
c: meta Component: intl-wide issues editorial Involves an editorial fix s: help wanted Status: help wanted; needs proposal champion
Projects
None yet
Milestone
ES 2025
Development

No branches or pull requests
3 participants
@sffc @gibson042 @ben-allen