devs/cproof
1
2
Fork 1
Code Issues 43 Pull Requests 6 Actions Packages Projects 1 Releases Wiki Activity

Fix documentation so it does not cause warnings by parsers #33

Manually merged
jabber.developer merged 5 commits from docs/minor-fixes into master 2025-09-30 08:59:20 +00:00
Conversation 0 Commits 5 Files Changed 6 +1238 -1295
jabber.developer commented 2025-09-16 23:01:14 +00:00
Owner
Copy Link

Fixes #32

Fixes #32
jabber.developer added 2 commits 2025-09-16 23:01:14 +00:00
docs(python): fix formatting to ensure correct parsing c94263486f 
Fixes issues introduced in 052e168, 4cdcf9a, and other commits from PR #31.
ci: restructure and optimize execution conditions
Some checks failed
CI API Docs / Test C API Documentation Generation (pull_request) Successful in 26s
Details
CI API Docs / Test Python API Documentation Generation (pull_request) Failing after 28s
Details
CI Code / Check coding style (pull_request) Has been cancelled
Details
CI Code / Check spelling (pull_request) Has been cancelled
Details
CI Code / Linux (arch) (pull_request) Has been cancelled
Details
CI Code / Linux (debian) (pull_request) Has been cancelled
Details
CI Code / Linux (ubuntu) (pull_request) Has been cancelled
Details
9fd62e2304 
- The code tests will ignore doc changes and vice versa.
- The CI is split in 2 parts for clarity
admin added 1 commit 2025-09-16 23:02:50 +00:00
docs: Fix indentation
Some checks failed
CI API Docs / Test Python API Documentation Generation (pull_request) Failing after 1m24s
Details
CI API Docs / Test C API Documentation Generation (pull_request) Successful in 1m32s
Details
CI Code / Check spelling (pull_request) Successful in 20s
Details
CI Code / Check coding style (pull_request) Successful in 1m45s
Details
CI Code / Linux (debian) (pull_request) Successful in 12m33s
Details
CI Code / Linux (arch) (pull_request) Successful in 19m7s
Details
CI Code / Linux (ubuntu) (pull_request) Successful in 24m45s
Details
9a43622cb1
admin force-pushed docs/minor-fixes from 9a43622cb1 to 92cb930810 2025-09-16 23:37:21 +00:00 Compare
admin added 1 commit 2025-09-22 21:06:09 +00:00
docs: move callbacks down
All checks were successful
CI API Docs / Test C API Documentation Generation (pull_request) Successful in 26s
Details
CI API Docs / Test Python API Documentation Generation (pull_request) Successful in 28s
Details
CI Code / Check coding style (pull_request) Successful in 36s
Details
CI Code / Check spelling (pull_request) Successful in 18s
Details
CI Code / Linux (debian) (pull_request) Successful in 13m40s
Details
CI Code / Linux (ubuntu) (pull_request) Successful in 14m9s
Details
CI Code / Linux (arch) (pull_request) Successful in 21m18s
Details
8849d9b79e 
To improve readability of the docs
admin added 1 commit 2025-09-23 12:05:31 +00:00
docs(apidocs/c): improve profapi.h and profhooks.h comments
Some checks failed
CI API Docs / Test C API Documentation Generation (pull_request) Failing after 27s
Details
CI API Docs / Test Python API Documentation Generation (pull_request) Successful in 28s
Details
CI Code / Check coding style (pull_request) Successful in 36s
Details
CI Code / Check spelling (pull_request) Successful in 18s
Details
CI Code / Linux (debian) (pull_request) Successful in 12m41s
Details
CI Code / Linux (ubuntu) (pull_request) Successful in 14m57s
Details
CI Code / Linux (arch) (pull_request) Successful in 18m59s
Details
6b558de902 
- Enhanced file-level comments with concise descriptions
- Added usage examples and aligned with Python prof module style
- Updated function comments to remove tables, improve clarity
- Replaced Profanity with CProof, preserved paths and method names
admin force-pushed docs/minor-fixes from 6b558de902 to 40dd773c6a 2025-09-23 12:07:40 +00:00 Compare
jabber.developer changed title from Fix documentation for parser to Fix documentation so it does not cause warnings by parsers 2025-09-29 13:30:10 +00:00
jabber.developer manually merged commit 40dd773c6a into master 2025-09-30 08:59:20 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
Compat/Breaking
Breaking change that won't be backward compatible
Kind/Bug
Something is not working
Kind/Documentation
Documentation changes
Kind/Enhancement
Improve existing functionality
Kind/Feature
New functionality
Kind/Security
This is security issue
Kind/Testing
Issue or pull request related to testing
Priority
Critical
1
The priority is critical
Priority
High
2
The priority is high
Priority
Low
4
The priority is low
Priority
Medium
3
The priority is medium
Reviewed
Confirmed
1
Issue has been confirmed
Reviewed
Duplicate
2
This issue or pull request already exists
Reviewed
Invalid
3
Invalid issue
Reviewed
Won't Fix
3
This issue won't be fixed
Status
Abandoned
3
Somebody has started to work on this but abandoned work
Status
Blocked
1
Something is blocking this issue or pull request
Status
Need More Info
2
Feedback is required to reproduce issue or to continue work
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
admin jabber.developer jabber.developer2
No Assignees
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: devs/cproof#33
No description provided.
Delete Branch "docs/minor-fixes"

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?