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

docs: adds JSDoc to the npm package '@ory/keto-namespace-types' #1136

Merged
merged 2 commits into from
Nov 17, 2022

Conversation

nidomiro
Copy link
Contributor

Adds JSDoc to the npm package '@ory/keto-namespace-types'.
This will enable displaying what the different methods do in the IDE as documentation

Related issue(s)

None

Checklist

  • I have read the contributing guidelines.
  • I have referenced an issue containing the design document if my change
    introduces a new feature.
  • I am following the
    contributing code guidelines.
  • I have read the security policy.
  • I confirm that this pull request does not address a security
    vulnerability. If this pull request addresses a security vulnerability, I
    confirm that I got the approval (please contact
    [email protected]) from the maintainers to push
    the changes.
  • I have added tests that prove my fix is effective or that my feature
    works.
    (not needed in my opinion)
  • I have added or changed the documentation. (not needed in my opinion)

Further Comments

Please give feedback if my understanding of the PermissionLanguage is correct

@nidomiro nidomiro force-pushed the feat/add-jsdoc-to-keto-namespace-types branch from cb63d11 to 8501e08 Compare November 16, 2022 09:47
Copy link
Member

@zepatrik zepatrik left a comment

Choose a reason for hiding this comment

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

This is a great idea, thanks a lot 😍

contrib/namespace-type-lib/index.d.ts Outdated Show resolved Hide resolved
contrib/namespace-type-lib/index.d.ts Outdated Show resolved Hide resolved
contrib/namespace-type-lib/index.d.ts Outdated Show resolved Hide resolved
@zepatrik zepatrik merged commit b582375 into ory:master Nov 17, 2022
@nidomiro nidomiro deleted the feat/add-jsdoc-to-keto-namespace-types branch November 17, 2022 19:26
@vinckr
Copy link
Member

vinckr commented Nov 28, 2022

@nidomiro
Congrats on merging your first PR in Ory 🎉 !
Your contribution will soon be helping secure millions of identities around the globe 🌏.
As a small token of appreciation we send all our first time contributors a gift package to welcome them to the community.
Please drop me an email and I will forward you the form to claim your Ory swag!

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