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

Updates to User client #451

Merged
merged 1 commit into from
Oct 18, 2023

Conversation

Laverne-Encord
Copy link
Collaborator

@Laverne-Encord Laverne-Encord commented Oct 18, 2023

Updated docs based on feedback from David and added a couple of tips for access control when using the SDK.

@github-actions
Copy link

github-actions bot commented Oct 18, 2023

Image description CodeRabbit

Walkthrough: This update primarily focuses on enhancing the documentation across multiple files. It introduces a tip for access control when using the SDK and improves the clarity of the get_dataset method in the User client by updating its comments.

Changes:

Files Summary
docs/source/general_concepts.rst, docs/source/tutorials/projects.rst Added a tip suggesting the creation of shared service accounts and generation of SSH keys for improved access control when using the SDK.
encord/user_client.py Updated the documentation for the get_dataset method to clarify its purpose and correct a typo.

Notes

Chat with Image description CodeRabbit Bot (@coderabbitai)

  • Reply on review comments left by this bot to ask follow-up questions. A review comment is a comment on a diff or a file.
  • Invite the bot into a review comment chain by tagging @coderabbitai in a reply.

Code suggestions

  • The bot may make code suggestions, but please review them carefully before committing since the line number ranges may be misaligned.
  • You can edit the comment made by the bot and manually tweak the suggestion if it is slightly off.

Ignoring further reviews

  • Type @coderabbitai: ignore anywhere in the PR description to ignore further reviews from the bot.

@github-actions
Copy link

Unit test report

124 tests   113 ✔️  5s ⏱️
    1 suites    11 💤
    1 files        0

Results for commit c10184b.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Image description CodeRabbit

Commits Files that changed from the base of the PR and between 2308da3 and c10184b commits.
Files selected (3)
  • docs/source/general_concepts.rst (1)
  • docs/source/tutorials/projects.rst (1)
  • encord/user_client.py (1)
Files skipped from review due to trivial changes (2)
  • docs/source/tutorials/projects.rst
  • encord/user_client.py
Review comments generated (2)
  • Review: 1
  • LGTM: 1

docs/source/general_concepts.rst Show resolved Hide resolved
Copy link
Contributor

@denis-cord denis-cord left a comment

Choose a reason for hiding this comment

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

Thanks!

@Laverne-Encord Laverne-Encord merged commit e141932 into master Oct 18, 2023
4 checks passed
@Laverne-Encord Laverne-Encord deleted the SDK-update-access-control-best-practice branch October 18, 2023 18:34
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.

2 participants