Skip to content

Commit

Permalink
Update API reference
Browse files Browse the repository at this point in the history
  • Loading branch information
dostuffthatmatters committed Dec 5, 2023
1 parent c64ce2d commit c1f086e
Showing 1 changed file with 4 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ hide_table_of_contents: true

---

<a href="https://github.com/tum-esm/pyra/tree/main/packages/core/threads/upload_thread.py#L8" className="SourceCodeLinkBadge">source code</a>
<a href="https://github.com/tum-esm/pyra/tree/main/packages/core/threads/upload_thread.py#L9" className="SourceCodeLinkBadge">source code</a>

## <kbd>class</kbd> `UploadThread`
Thread for uploading data to a server via SCP.
Expand All @@ -27,7 +27,7 @@ See https://github.com/dostuffthatmatters/circadian-scp-upload for a description

---

<a href="https://github.com/tum-esm/pyra/tree/main/packages/core/threads/upload_thread.py#L23" className="SourceCodeLinkBadge">source code</a>
<a href="https://github.com/tum-esm/pyra/tree/main/packages/core/threads/upload_thread.py#L24" className="SourceCodeLinkBadge">source code</a>

### <kbd>method</kbd> `get_new_thread_object`

Expand All @@ -39,7 +39,7 @@ Return a new thread object that is to be started.

---

<a href="https://github.com/tum-esm/pyra/tree/main/packages/core/threads/upload_thread.py#L28" className="SourceCodeLinkBadge">source code</a>
<a href="https://github.com/tum-esm/pyra/tree/main/packages/core/threads/upload_thread.py#L29" className="SourceCodeLinkBadge">source code</a>

### <kbd>method</kbd> `main`

Expand All @@ -51,7 +51,7 @@ Main entrypoint of the thread. In headless mode, don't write to log files but p

---

<a href="https://github.com/tum-esm/pyra/tree/main/packages/core/threads/upload_thread.py#L13" className="SourceCodeLinkBadge">source code</a>
<a href="https://github.com/tum-esm/pyra/tree/main/packages/core/threads/upload_thread.py#L14" className="SourceCodeLinkBadge">source code</a>

### <kbd>method</kbd> `should_be_running`

Expand Down

0 comments on commit c1f086e

Please sign in to comment.