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

added fixed docstirngs #739

Merged

Conversation

jakubczakon
Copy link
Contributor

  • added fixed docstrings

@jakubczakon jakubczakon requested a review from Raalsky October 18, 2021 14:17
If 'None' it will be parsed from the `name` argument.
visibility(str, optional): level of visibility you want your project to have.
Can be set to:
- 'pub' for public projects
Copy link
Contributor

Choose a reason for hiding this comment

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

Old value management.ProjectVisibility should work fine. Only workspace(str, optional) was required to be updated

Copy link
Contributor

Choose a reason for hiding this comment

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

It also applies to other enums

Copy link
Contributor Author

Choose a reason for hiding this comment

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

But what is recommended then?
What is simpler for the users to use?
What do we want people to use?

@Herudaio as you own the experience of API afaik what do you recommend?

For me as an ML person when I have two options:

  • function(... member="contributor")
  • function(... member=neptune.management.MemberRoles.CONTRIBUTOR)

I like the first one way more.

Copy link
Contributor

Choose a reason for hiding this comment

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

I would go for the first one as the suggested one i.e. member="contributor"
Primarily as this is a follow-up on the design pattern decision we already made with regard to other enums/constants e.g. connection modes.

@jakubczakon jakubczakon merged commit 9f13c18 into rj/mgmt-str-instead-enum Oct 19, 2021
@jakubczakon jakubczakon deleted the kc/project-management-api-docstrings branch October 19, 2021 10:50
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