docs: add docstrings to auth objects and endpoints#1484
Merged
Uh oh!
There was an error while loading. Please reload this page.
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
jorwoodsforce-pushed the jorwoods/auth_docstrings branch from e41321d to 402622fCompare
jorwoods commented Oct 2, 2024
Comment on lines 95 to 103
| @api(version="3.6") | ||
| defsign_in_with_personal_access_token(self, auth_req: "Credentials") ->contextmgr: | ||
| """Passthrough to sign_in method""" | ||
| returnself.sign_in(auth_req) | ||
| @api(version="3.17") | ||
| defsign_in_with_json_web_token(self, auth_req: "Credentials") ->contextmgr: | ||
| """Passthrough to sign_in method""" | ||
| returnself.sign_in(auth_req) |
ContributorAuthor
There was a problem hiding this comment.
Since these are pass through methods, should they be deprecated?
Contributor
There was a problem hiding this comment.
I think it's worth keeping them, because signing in is something people are working on when they don't necessarily understand the library or API. It just adds a bit of scaffolding for them.
jacalata approved these changes Oct 10, 2024
jacalata added a commit that referenced this pull request Oct 24, 2024
* Feature: export custom views #999 (#1506) * feat(exceptions): separate failed signin error (#1478) * refactor request_options, add language param (#1481) * Set FILESIZE_LIMIT_MB via environment variables (#1466) * added PulseMetricDefine cap (#1490) * Adding project permissions handling for databases, tables and virtual connections (#1482) * fix: queryset support for flowruns (#1460) * fix: set unknown size to sys.maxsize * fix: handle 0 item response in querysets (#1501) * chore: support VizqlDataApiAccess capability (#1504) * refactor(test): extract error factory to _utils * chore(typing): flowruns.cancel can also accept a FlowRunItem * chore: type hint default permissions endpoints (#1493) * chore(versions): update remaining f-strings (#1477) * Make urllib3 dependency more flexible (#1468) * Update requests library for CVE CVE-2024-35195 (#1507) * chore(versions): Upgrade minimum python version (#1465) * ci: cache dependencies for faster builds (#1497) * ci: build on python 3.13 (#1492) * Update samples for Python 3.x compatibility (#1479) * chore: remove py2 holdover code (#1496) * #Add 'description' to datasource sample code (#1475) * Remove sample code showing group name encoding (#1486) * chore(typing): include samples in type checks (#1455) * fix: docstring on QuerySet * docs: add docstrings to auth objects and endpoints (#1484) * docs: docstrings for Server and ServerInfo (#1494) * docs: docstrings for user item and endpoint (#1485) * docs: docstrings for site item and endpoint (#1495) * docs: workbook docstrings (#1488) * #1464 - docs update for filtering on boolean values (#1471) --------- Co-authored-by: Brian Cantoni <[email protected]> Co-authored-by: Jordan Woods <[email protected]> Co-authored-by: Jordan Woods <[email protected]> Co-authored-by: Jac <[email protected]> Co-authored-by: Henning Merklinger <[email protected]> Co-authored-by: AlbertWangXu <[email protected]> Co-authored-by: TrimPeachu <[email protected]>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.