Skip to content

Commit

Permalink
DOC: Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mgxd committed Oct 21, 2024
1 parent d2c82e4 commit 2b1d1c3
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 9 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import migas; migas.setup(endpoint='your-endpoint')

`migas` includes the following functions to communicate with the telemetry server:

### migas.add_breadcrumb()
### [migas.add_breadcrumb] (#add-breadcrumb)
---
Send a breadcrumb with usage information to the server.

Expand Down Expand Up @@ -57,12 +57,12 @@ Send a breadcrumb with usage information to the server.

```python
>>> add_breadcrumb('nipreps/migas-py', '0.0.1', status='R', status_desc='Finished long step')
{'success': True}
>>>
```

</details>

### migas.check_project()
### [migas.check_project] (#check-project)
---
Check a project version against later developments.

Expand All @@ -81,7 +81,7 @@ Check a project version against later developments.

</details>

### migas.get_usage()
### [migas.get_usage] (#get-usage)
---
Check number of uses a `project` has received from a start date, and optionally an end date.
If no end date is specified, the current datetime is used.
Expand All @@ -97,11 +97,11 @@ If no end date is specified, the current datetime is used.
</details>


### migas.track_exit()
### [migas.track_exit] (#track-exit)
---
Register an exit function to send a final ping upon termination of the Python interpretter.
Useful when monitoring a process that may preemptively error.
The inputs are equivalent to [`add_breadcrumb()`](#addbreadcrumb)
The inputs are equivalent to [`add_breadcrumb()`](#add-breadcrumb)

## User Control

Expand Down
3 changes: 0 additions & 3 deletions migas/request.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,7 @@ def request(
)

if wait is True:
print('Waiting for result!')
return future.result()
else:
print('No wait!')


def _request(
Expand Down

0 comments on commit 2b1d1c3

Please sign in to comment.