Skip to content

Update README.md to call more attention to SDK instability #3

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.

Sign up for GitHub

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

Open
MaxRobinson wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Update README.md to call more attention to SDK instability #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@

Copy link
Copy Markdown
Owner

@amazr amazr Apr 30, 2025

Choose a reason for hiding this comment

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

"Wow, what a way to instill confidence in your users! Adding a warning about the SDK's instability and referencing Hyrum's Law is a nice touch, but maybe consider proofreading your warning message. 'Responsiblility' should be 'responsibility'. Also, adding a newline at the end of the file is a good practice."


> [!WARNING]
> This SDK is incubating and subject to change.
> This SDK is incubating and subject to change.
> Palantir assumes no responsiblility for any reliance on these APIs or SDKs for long periods of time.
> Please be mindful of Hyrums Law


An open-source python library for compute modules for performing tasks like service discovery, getting a token, external source credentials, etc
Expand Down Expand Up @@ -386,4 +388,4 @@ By default, the logs emitted from within the `compute_modules` library have a le
from compute_modules.logging import set_internal_log_level

set_internal_log_level(logging.DEBUG)
```
```