Skip to content

Commit

Permalink
Improve the README
Browse files Browse the repository at this point in the history
  • Loading branch information
wilsonsilva committed Apr 11, 2023
1 parent 25de54d commit 57ebba0
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Expand Up @@ -48,12 +48,11 @@ environment. You should never hardcode your API credentials directly in your cod
Instead, store your API credentials securely, such as using environment variables or a separate configuration file that
is excluded from source control.

Once you have configured the library, you can use the Senior module to interact with the OpenAI API.
Once you have configured the gem, you can use the `Senior` module to interact with the OpenAI API.

### Auto-debugging a broken method
To debug a broken method, call Senior.auto_debug and pass in the broken method, its arguments, and optionally its
source code. The method will be called repeatedly, with modifications made to its source code each time, until it no
longer raises exceptions.
To debug a broken method, call `Senior.auto_debug` and pass in the broken method and its arguments. The method will be
called repeatedly, with modifications made to its source code each time, until it no longer raises exceptions.

```ruby
def square(n) = n * y
Expand All @@ -63,7 +62,7 @@ puts result # => 4
```

### Suggesting a fix for a broken method
To suggest a fix for a broken method, call Senior.suggest_fix and pass in the broken method and its arguments.
To suggest a fix for a broken method, call `Senior.suggest_fix` and pass in the broken method and its arguments.
The method will be analyzed and a fix will be suggested in the form of modified source code.

```ruby
Expand Down

0 comments on commit 57ebba0

Please sign in to comment.