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

Add documentation #31

Merged
k.marinus merged 6 commits from docs/docs-cb into dev 2025-11-27 12:16:12 +00:00
Conversation 21 Commits 6 Files Changed 30 +778 -83
k.marinus commented 2025-11-25 11:08:29 +00:00 (Migrated from git.science.uu.nl)
Copy Link

Add documentation to all classes in the CB. No functionality should be changed.

To test, make sure the following holds:

  • Tests pass
  • Code adheres to style guide
  • Functionality is intact
  • Documentation is present for all classes and methods
  • Documentation is clear
  • Documentation renders correctly in HTML

Note that the test functions have not yet been documented.

see: N25B-295

Add documentation to all classes in the CB. No functionality should be changed. To test, make sure the following holds: * [x] Tests pass * [x] Code adheres to style guide * [x] Functionality is intact * [x] Documentation is present for all classes and methods * [x] Documentation is clear * [x] Documentation renders correctly in HTML Note that the test functions have not yet been documented. see: N25B-295
0950726 commented 2025-11-25 11:13:55 +00:00 (Migrated from git.science.uu.nl)
Copy Link

marked the checklist item Tests pass as completed

marked the checklist item **Tests pass** as completed
k.marinus commented 2025-11-25 11:14:18 +00:00 (Migrated from git.science.uu.nl)
Copy Link

added 6 commits

  • 129d3c44...435f0c25 - 2 commits from branch dev
  • d513111e - Merge remote-tracking branch 'origin/dev' into feat/norms-and-goals-program
  • 11b5345a - fix: do not await add_behavior anymore
  • ce058c38 - fix: correct typing, simplify logs
  • 5598c6b8 - Merge branch 'feat/norms-and-goals-program' into docs/docs-cb

Compare with previous version

added 6 commits <ul><li>129d3c44...435f0c25 - 2 commits from branch <code>dev</code></li><li>d513111e - Merge remote-tracking branch &#39;origin/dev&#39; into feat/norms-and-goals-program</li><li>11b5345a - fix: do not await add_behavior anymore</li><li>ce058c38 - fix: correct typing, simplify logs</li><li>5598c6b8 - Merge branch &#39;feat/norms-and-goals-program&#39; into docs/docs-cb</li></ul> [Compare with previous version](/ics/sp/2025/n25b/pepperplus-cb/-/merge_requests/31/diffs?diff_id=134352&start_sha=129d3c4420dd8e0bbb1424b9d7a7da1aee332e77)
k.marinus commented 2025-11-25 11:21:26 +00:00 (Migrated from git.science.uu.nl)
Copy Link

added 3 commits

  • 5598c6b8...6dc59d00 - 2 commits from branch dev
  • ae7c7a02 - Merge branch 'dev' into docs/docs-cb

Compare with previous version

added 3 commits <ul><li>5598c6b8...6dc59d00 - 2 commits from branch <code>dev</code></li><li>ae7c7a02 - Merge branch &#39;dev&#39; into docs/docs-cb</li></ul> [Compare with previous version](/ics/sp/2025/n25b/pepperplus-cb/-/merge_requests/31/diffs?diff_id=134362&start_sha=5598c6b8feefda99f01628bd703d8b5c8b7096ab)
0950726 commented 2025-11-25 11:21:56 +00:00 (Migrated from git.science.uu.nl)
Copy Link

marked the checklist item Code adheres to style guide as completed

marked the checklist item **Code adheres to style guide** as completed
k.marinus commented 2025-11-25 11:23:41 +00:00 (Migrated from git.science.uu.nl)
Copy Link

changed the description

changed the description
2584433 commented 2025-11-25 11:36:03 +00:00 (Migrated from git.science.uu.nl)
Copy Link

approved this merge request

approved this merge request
2584433 commented 2025-11-25 11:39:13 +00:00 (Migrated from git.science.uu.nl)
Copy Link

No docstring

No docstring
2584433 commented 2025-11-25 11:42:06 +00:00 (Migrated from git.science.uu.nl)
Copy Link

docstring to explain what happens if nothing is given as input.

docstring to explain what happens if nothing is given as input.
2584433 commented 2025-11-25 11:44:35 +00:00 (Migrated from git.science.uu.nl)
Copy Link

missing docstring

missing docstring
0950726 commented 2025-11-25 11:45:32 +00:00 (Migrated from git.science.uu.nl)
Copy Link

added 1 commit

  • 78923d3d - fix: move BDI core agent to make documentation generation better

Compare with previous version

added 1 commit <ul><li>78923d3d - fix: move BDI core agent to make documentation generation better</li></ul> [Compare with previous version](/ics/sp/2025/n25b/pepperplus-cb/-/merge_requests/31/diffs?diff_id=134373&start_sha=ae7c7a02368c4a0bca1d35ee0c8ed49c13c34dd7)
2584433 commented 2025-11-25 11:46:03 +00:00 (Migrated from git.science.uu.nl)
Copy Link

maybe make this comment the docstring of init_subclass

maybe make this comment the docstring of __init_subclass__
2584433 commented 2025-11-25 11:48:22 +00:00 (Migrated from git.science.uu.nl)
Copy Link

the comment above the init

the comment above the init
0950726 commented 2025-11-25 11:49:20 +00:00 (Migrated from git.science.uu.nl)
Copy Link

marked the checklist item Functionality is intact as completed

marked the checklist item **Functionality is intact** as completed
2584433 commented 2025-11-25 11:51:11 +00:00 (Migrated from git.science.uu.nl)
Copy Link

Setup_logging.py (setup_logging line 39) should probably have a docstring

Setup_logging.py (setup_logging line 39) should probably have a docstring
2584433 commented 2025-11-25 11:51:27 +00:00 (Migrated from git.science.uu.nl)
Copy Link

marked the checklist item Documentation is clear as completed

marked the checklist item **Documentation is clear** as completed
k.marinus commented 2025-11-25 11:53:52 +00:00 (Migrated from git.science.uu.nl)
Copy Link

resolved all threads

resolved all threads
k.marinus commented 2025-11-25 11:56:37 +00:00 (Migrated from git.science.uu.nl)
Copy Link

added 2 commits

  • 953fde7b - chore: apply suggestions
  • 261aea4f - Merge remote-tracking branch 'origin/docs/docs-cb' into docs/docs-cb

Compare with previous version

added 2 commits <ul><li>953fde7b - chore: apply suggestions</li><li>261aea4f - Merge remote-tracking branch &#39;origin/docs/docs-cb&#39; into docs/docs-cb</li></ul> [Compare with previous version](/ics/sp/2025/n25b/pepperplus-cb/-/merge_requests/31/diffs?diff_id=134377&start_sha=78923d3d072f0ef9e481a0b99d65f11093b620f7)
0950726 commented 2025-11-27 12:16:04 +00:00 (Migrated from git.science.uu.nl)
Copy Link

marked the checklist item Documentation is present for all classes and methods as completed

marked the checklist item **Documentation is present for all classes and methods** as completed
0950726 commented 2025-11-27 12:16:04 +00:00 (Migrated from git.science.uu.nl)
Copy Link

marked the checklist item Documentation renders correctly in HTML as completed

marked the checklist item **Documentation renders correctly in HTML** as completed
0950726 commented 2025-11-27 12:16:12 +00:00 (Migrated from git.science.uu.nl)
Copy Link

mentioned in commit c85753f834

mentioned in commit c85753f8348ca562398dc1b0bbeb5883b5d23f0a
0950726 (Migrated from git.science.uu.nl) merged commit c85753f834 into dev 2025-11-27 12:16:12 +00:00
2584433 (Migrated from git.science.uu.nl) approved these changes 2026-02-02 13:29:06 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
2584433
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-cb#31
Delete Branch "docs/docs-cb"

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?