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.

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

Add "description"s guidelines for Permissions API descriptions #5911

Closed
bershanskiy opened this issue Mar 30, 2020 · 0 comments · Fixed by #6156
Closed

Add "description"s guidelines for Permissions API descriptions #5911

bershanskiy opened this issue Mar 30, 2020 · 0 comments · Fixed by #6156
Labels
docs Issues or pull requests regarding the documentation of this project. linter Issues or pull requests regarding the tests / linter of the JSON files.

Comments

@bershanskiy
Copy link
Contributor

Descriptions that are not linted are susceptible to copy-paste errors, as can be seen in #5909. I propose we:

  • document already existing practice in Data guidelines by adding:

    Permissions API permissions (api.Permissions.*_permission.__compat.description)

    Document Permissions API permission called [permissionname] as api.Permissions.[permissionname]_permission and add a description that reads "<code>[permissionname]</code> permission"
    For example, the Geolocation permission is named geolocation_permission with the description text <code>geolocation</code> permission, like this:

    {
     "api": {
       "Permissions": {
         "__compat": {},
         "geolocation_permission": {
           "__compat": {
             "description": "<code>geolocation</code> permission",
             "support": {}
           }
         }
       }
     }
    }
    
  • create a linter to fix errors like those in Fix api.Permissions.*.__compat.description #5909

CC @vinyldarkscratch

@bershanskiy bershanskiy changed the title Add "description"s guidelines for Permissions Add "description"s guidelines for Permissions API descriptions Mar 30, 2020
@queengooborg queengooborg added the linter Issues or pull requests regarding the tests / linter of the JSON files. label Mar 30, 2020
@ddbeck ddbeck added the docs Issues or pull requests regarding the documentation of this project. label Mar 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues or pull requests regarding the documentation of this project. linter Issues or pull requests regarding the tests / linter of the JSON files.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants