pepperplus/pepperplus-ri
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

chore: add documentation RI #11

Merged
8464960 merged 6 commits from chore/add-documentation into dev 2025-11-22 19:14:51 +00:00
Conversation 37 Commits 6 Files Changed 19 +474 -67
8464960 commented 2025-11-21 15:47:58 +00:00 (Migrated from git.science.uu.nl)
Copy Link

Code functionality left unchanged, only added docs where missing

For review pay special attention to:

  • Verify that the :type and :rtype tags in all new docstrings accurately reflect the expected Python data types
  • Verify that the descriptions of classes and methods make sense
  • Pull the branch, generate the HTML documentation locally using the instructions in the README.md, and check that the new documentation renders correctly and adheres to the project's visual style.

close: N25B-298

Code functionality left unchanged, only added docs where missing For review pay special attention to: - [ ] Verify that the :type and :rtype tags in all new docstrings accurately reflect the expected Python data types - [ ] Verify that the descriptions of classes and methods make sense - [ ] Pull the branch, generate the HTML documentation locally using the instructions in the README.md, and check that the new documentation renders correctly and adheres to the project's visual style. close: N25B-298
8464960 commented 2025-11-21 15:47:58 +00:00 (Migrated from git.science.uu.nl)
Copy Link

assigned to @8464960

assigned to @8464960
0950726 commented 2025-11-21 17:54:37 +00:00 (Migrated from git.science.uu.nl)
Copy Link

At least PyCharm can infer constructor argument docs from ivar declarations when the names are the same (not in Python 2.7).

To make it less verbose, I suggest removing the param docs for these classes.

At least PyCharm can infer constructor argument docs from `ivar` declarations when the names are the same (not in Python 2.7). To make it less verbose, I suggest removing the `param` docs for these classes.
0950726 commented 2025-11-21 18:07:43 +00:00 (Migrated from git.science.uu.nl)
Copy Link

This blank line can be removed

This blank line can be removed ```suggestion:-0+0 ```
0950726 commented 2025-11-21 18:12:57 +00:00 (Migrated from git.science.uu.nl)
Copy Link

Hmm the type in the __init__ argument limit_ms was allowed to be int, but the type of the class attribute is definitely never int.

Hmm the type in the `__init__` argument `limit_ms` was allowed to be `int`, but the type of the class attribute is definitely never `int`.
0950726 commented 2025-11-21 18:19:20 +00:00 (Migrated from git.science.uu.nl)
Copy Link

These are good test descriptions 👍 Describing the arguments types is excessive though, especially because they're almost all the same.

These are good test descriptions 👍 Describing the arguments types is excessive though, especially because they're almost all the same.
0950726 commented 2025-11-21 18:27:35 +00:00 (Migrated from git.science.uu.nl)
Copy Link

Good work!

In many places, type is used with ivar. The generated HTML docs generator does not seem to understand these. vartype is used in ActuationReceiver, which the generator does understand. Perhaps change all ivar types to use vartype.

Good work! In many places, `type` is used with `ivar`. The generated HTML docs generator does not seem to understand these. `vartype` is used in `ActuationReceiver`, which the generator does understand. Perhaps change all `ivar` types to use `vartype`.
k.marinus commented 2025-11-21 18:36:52 +00:00 (Migrated from git.science.uu.nl)
Copy Link

How did you determine this was an SSLSession? As far as I can determine, it's a qi.Object

How did you determine this was an `SSLSession`? As far as I can determine, it's a `qi.Object`
k.marinus commented 2025-11-21 18:36:52 +00:00 (Migrated from git.science.uu.nl)
Copy Link

The types of these variables don't show up in the generated documentation for me

The types of these variables don't show up in the generated documentation for me
k.marinus commented 2025-11-21 18:36:52 +00:00 (Migrated from git.science.uu.nl)
Copy Link

I think this is missing a :param: entry for identifier

I think this is missing a `:param:` entry for `identifier`
k.marinus commented 2025-11-21 18:36:52 +00:00 (Migrated from git.science.uu.nl)
Copy Link

Perhaps a reference to the ZMQ docs could be useful here?

Perhaps a reference to the ZMQ docs could be useful here?
k.marinus commented 2025-11-21 18:36:52 +00:00 (Migrated from git.science.uu.nl)
Copy Link

This does not seem to generate correctly: image{width=472 height=150}

This does not seem to generate correctly: ![image](/uploads/de91de20f269b6e50431eccdce0b63fc/image.png){width=472 height=150}
k.marinus commented 2025-11-21 18:36:52 +00:00 (Migrated from git.science.uu.nl)
Copy Link

Typo:

        Will not start if no qi session is available.
Typo: ```suggestion:-0+0 Will not start if no qi session is available. ```
k.marinus commented 2025-11-21 18:36:53 +00:00 (Migrated from git.science.uu.nl)
Copy Link

Maybe just make this qi.Object

Maybe just make this `qi.Object`
k.marinus commented 2025-11-21 18:36:53 +00:00 (Migrated from git.science.uu.nl)
Copy Link
        :type vid_stream_name: str
```suggestion:-0+0 :type vid_stream_name: str ```
k.marinus commented 2025-11-21 18:36:53 +00:00 (Migrated from git.science.uu.nl)
Copy Link

Some of the return specifications don't seem to generate correctly. I have made one comment on this in the changes, but I'll also insert an example image here:

image.png{width=507 height=90}

Some of the return specifications don't seem to generate correctly. I have made one comment on this in the changes, but I'll also insert an example image here: ![image.png](/uploads/fe59bd14c3cda91ada3c209865335eec/image.png){width=507 height=90}
k.marinus commented 2025-11-21 18:36:54 +00:00 (Migrated from git.science.uu.nl)
Copy Link

left review comments

left review comments
0950726 commented 2025-11-21 18:43:23 +00:00 (Migrated from git.science.uu.nl)
Copy Link

Ah, because there's a newline. I guess this happens in more cases.

Ah, because there's a newline. I guess this happens in more cases.
8464960 commented 2025-11-22 10:46:22 +00:00 (Migrated from git.science.uu.nl)
Copy Link

changed this file in version 2 of the diff

changed this file in [version 2 of the diff](/ics/sp/2025/n25b/pepperplus-ri/-/merge_requests/11/diffs?diff_id=134076&start_sha=051f9045768c7e26a150f29cef76ef7333b589ea#84d1152ca66f4bc53f52182150359a8b4e719172)
8464960 commented 2025-11-22 10:46:23 +00:00 (Migrated from git.science.uu.nl)
Copy Link

changed this line in version 2 of the diff

changed this line in [version 2 of the diff](/ics/sp/2025/n25b/pepperplus-ri/-/merge_requests/11/diffs?diff_id=134076&start_sha=051f9045768c7e26a150f29cef76ef7333b589ea#62f83f5613d0d6aa71039b65c7f98b8585580506_54_54)
8464960 commented 2025-11-22 10:46:23 +00:00 (Migrated from git.science.uu.nl)
Copy Link

changed this file in version 2 of the diff

changed this file in [version 2 of the diff](/ics/sp/2025/n25b/pepperplus-ri/-/merge_requests/11/diffs?diff_id=134076&start_sha=051f9045768c7e26a150f29cef76ef7333b589ea#6d957eb34184a468caceac6a6311359af710bb0d)
8464960 commented 2025-11-22 10:46:23 +00:00 (Migrated from git.science.uu.nl)
Copy Link

changed this line in version 2 of the diff

changed this line in [version 2 of the diff](/ics/sp/2025/n25b/pepperplus-ri/-/merge_requests/11/diffs?diff_id=134076&start_sha=051f9045768c7e26a150f29cef76ef7333b589ea#de437161b76ff5e501950e208fff18a8e8803bb0_23_23)
8464960 commented 2025-11-22 10:46:23 +00:00 (Migrated from git.science.uu.nl)
Copy Link

changed this line in version 2 of the diff

changed this line in [version 2 of the diff](/ics/sp/2025/n25b/pepperplus-ri/-/merge_requests/11/diffs?diff_id=134076&start_sha=051f9045768c7e26a150f29cef76ef7333b589ea#62f83f5613d0d6aa71039b65c7f98b8585580506_33_33)
8464960 commented 2025-11-22 10:46:24 +00:00 (Migrated from git.science.uu.nl)
Copy Link

changed this line in version 2 of the diff

changed this line in [version 2 of the diff](/ics/sp/2025/n25b/pepperplus-ri/-/merge_requests/11/diffs?diff_id=134076&start_sha=051f9045768c7e26a150f29cef76ef7333b589ea#9a20a5d699e53c4196311f502bdee03a9f36a2b9_46_49)
8464960 commented 2025-11-22 10:46:24 +00:00 (Migrated from git.science.uu.nl)
Copy Link

changed this line in version 2 of the diff

changed this line in [version 2 of the diff](/ics/sp/2025/n25b/pepperplus-ri/-/merge_requests/11/diffs?diff_id=134076&start_sha=051f9045768c7e26a150f29cef76ef7333b589ea#8604da595eeb0afbe844103d71f4acea32e780de_27_27)
8464960 commented 2025-11-22 10:46:24 +00:00 (Migrated from git.science.uu.nl)
Copy Link

added 1 commit

Compare with previous version

added 1 commit <ul><li>c5330753 - chore: applied all feedback</li></ul> [Compare with previous version](/ics/sp/2025/n25b/pepperplus-ri/-/merge_requests/11/diffs?diff_id=134076&start_sha=051f9045768c7e26a150f29cef76ef7333b589ea)
0950726 commented 2025-11-22 11:38:34 +00:00 (Migrated from git.science.uu.nl)
Copy Link

There's a blank line at the beginning of the function.

There's a blank line at the beginning of the function. ```suggestion:-0+0 ```
0950726 commented 2025-11-22 11:44:17 +00:00 (Migrated from git.science.uu.nl)
Copy Link

added 1 commit

  • 64c6f0ad - docs: make doc generator understand multi line

Compare with previous version

added 1 commit <ul><li>64c6f0ad - docs: make doc generator understand multi line</li></ul> [Compare with previous version](/ics/sp/2025/n25b/pepperplus-ri/-/merge_requests/11/diffs?diff_id=134078&start_sha=c53307530b524d620da7c11452a0aaa452899b89)
8464960 commented 2025-11-22 12:36:37 +00:00 (Migrated from git.science.uu.nl)
Copy Link

changed this line in version 4 of the diff

changed this line in [version 4 of the diff](/ics/sp/2025/n25b/pepperplus-ri/-/merge_requests/11/diffs?diff_id=134082&start_sha=64c6f0addb6d2b22ac42f1a2457b1bc607bb3030#de437161b76ff5e501950e208fff18a8e8803bb0_26_26)
8464960 commented 2025-11-22 12:36:37 +00:00 (Migrated from git.science.uu.nl)
Copy Link

added 1 commit

  • 6859451b - Apply 1 suggestion(s) to 1 file(s)

Compare with previous version

added 1 commit <ul><li>6859451b - Apply 1 suggestion(s) to 1 file(s)</li></ul> [Compare with previous version](/ics/sp/2025/n25b/pepperplus-ri/-/merge_requests/11/diffs?diff_id=134082&start_sha=64c6f0addb6d2b22ac42f1a2457b1bc607bb3030)
8464960 commented 2025-11-22 12:37:40 +00:00 (Migrated from git.science.uu.nl)
Copy Link

changed this line in version 5 of the diff

changed this line in [version 5 of the diff](/ics/sp/2025/n25b/pepperplus-ri/-/merge_requests/11/diffs?diff_id=134084&start_sha=6859451bf9036033f35af21c729b3657f54afee0#8604da595eeb0afbe844103d71f4acea32e780de_52_52)
8464960 commented 2025-11-22 12:37:41 +00:00 (Migrated from git.science.uu.nl)
Copy Link

added 1 commit

  • c1e92feb - Apply 1 suggestion(s) to 1 file(s)

Compare with previous version

added 1 commit <ul><li>c1e92feb - Apply 1 suggestion(s) to 1 file(s)</li></ul> [Compare with previous version](/ics/sp/2025/n25b/pepperplus-ri/-/merge_requests/11/diffs?diff_id=134084&start_sha=6859451bf9036033f35af21c729b3657f54afee0)
0950726 commented 2025-11-22 18:32:54 +00:00 (Migrated from git.science.uu.nl)
Copy Link

added 1 commit

  • a5387136 - docs: remove duplicate and double space

Compare with previous version

added 1 commit <ul><li>a5387136 - docs: remove duplicate and double space</li></ul> [Compare with previous version](/ics/sp/2025/n25b/pepperplus-ri/-/merge_requests/11/diffs?diff_id=134113&start_sha=c1e92feba7c10969792416a703eb8ccb237abc3d)
0950726 commented 2025-11-22 18:33:01 +00:00 (Migrated from git.science.uu.nl)
Copy Link

approved this merge request

approved this merge request
k.marinus commented 2025-11-22 19:14:18 +00:00 (Migrated from git.science.uu.nl)
Copy Link

approved this merge request

approved this merge request
k.marinus commented 2025-11-22 19:14:51 +00:00 (Migrated from git.science.uu.nl)
Copy Link

mentioned in commit 8d6dd23acb

mentioned in commit 8d6dd23acbf0e4ac81ef4b6db4736442ad1a890a
k.marinus (Migrated from git.science.uu.nl) merged commit 8d6dd23acb into dev 2025-11-22 19:14:51 +00:00
0950726 (Migrated from git.science.uu.nl) approved these changes 2026-02-02 13:26:45 +00:00
k.marinus (Migrated from git.science.uu.nl) approved these changes 2026-02-02 13:26:45 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
0950726
k.marinus
Labels
No items
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
kasper twirre pepperplus
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: pepperplus/pepperplus-ri#11
Delete Branch "chore/add-documentation"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?