Skip to content

[SWE Destroyer] Add a hello world function to the README.md file #265

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

Closed
danielmillerp wants to merge 1 commit into from
Closed

[SWE Destroyer] Add a hello world function to the README.md file #265

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
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,17 @@ The REST API documentation can be found on [docs.gp.scale.com](https://docs.gp.s
pip install agentex-sdk
```

## Hello World

A simple hello world example to get started with the Agentex SDK:

```python
def hello_world():
print("Hello, World!")

hello_world()
```
Comment on lines +24 to +33
Copy link

@greptile-apps greptile-apps bot Feb 24, 2026

Choose a reason for hiding this comment

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

Hello world example doesn't use the SDK

The section says "A simple hello world example to get started with the Agentex SDK" but the code is a plain Python print("Hello, World!") function that has nothing to do with the Agentex SDK. This is misleading for users reading the README to learn how to use the library.

The existing "Usage" section (lines 35–50) already provides a minimal SDK example that actually demonstrates creating a client and making an API call. Consider either:

  1. Replacing this with a minimal example that actually imports and uses the Agentex SDK (similar to the Usage section), or
  2. Removing this section entirely since the "Usage" section already serves as a getting-started example.
Prompt To Fix With AI 
This is a comment left during a code review.
Path: README.md
Line: 24-33

Comment:
**Hello world example doesn't use the SDK**

The section says "A simple hello world example to get started with the Agentex SDK" but the code is a plain Python `print("Hello, World!")` function that has nothing to do with the Agentex SDK. This is misleading for users reading the README to learn how to use the library.

The existing "Usage" section (lines 35–50) already provides a minimal SDK example that actually demonstrates creating a client and making an API call. Consider either:
1. Replacing this with a minimal example that actually imports and uses the Agentex SDK (similar to the Usage section), or
2. Removing this section entirely since the "Usage" section already serves as a getting-started example.

How can I resolve this? If you propose a fix, please make it concise.


## Usage

The full API of this library can be found in [api.md](api.md).
Expand Down