Skip to content

Naming convention in components #1450

Open
@RVitaly1978

Description

@RVitaly1978

We though it would be a good idea to develop a naming convention in components for:

  • props
  • emits
  • public methods
  • slots

But it's not clear that this problem exists right now and is significant. So:

  • First look through docs if there are cases when same word is used for different things, or different words are used for same things. You can use algolia search or manually go through pages.
  • If that's indeed happens more than 1-2 times - raise up the discussion. If it's not a problem - inform in chat and close this issue.

Here's couple of ideas for implementation I came up with (should be decided after discussion):

If needed: create a script that retrieves data in the same way as the API in the documentation, processes, and presents the data. In order to assess how inconsistent naming is now, we need to conduct a study and summarize the data obtained in a form convenient for analysis:

  • sorting
  • table
  • graph
  • maybe something else...

Discussion done in context of status update

Metadata

Metadata

Assignees

No one assigned

    Labels

    d5: nightmare!Task for core contributors. Monsters attack more rapidly, demons and spectres move and fly faster.docspackages/docsrefactoringPrettify code without introducing new featuresresearchRequires researchv2: nice to haveThis will make Vuestic feel better

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions