Skip to content

Improve documentation#90

Merged
maxjeblick merged 17 commits intomainfrom
max/improve_docs
Jul 7, 2025
Merged

Improve documentation#90
maxjeblick merged 17 commits intomainfrom
max/improve_docs

Conversation

@maxjeblick
Copy link
Copy Markdown
Collaborator

PR description

Add verbose documentation for all presses.
Also fixed some minor issues in the README.
Remaining code changes are coming from make format. IMO, it could make sense to add a github action that check make format doesn't format the code again (i.e. it is already formatted).

Fixes #88

Checklist

  • Tests are working (make test)
  • Code is formatted correctly (make style, on errors try fix with make format)
  • Copyright header is included
  • All commits are signed-off using git commit -s
  • (new press) mypress_press.py is in the presses directory
  • (new press) MyPress is in __init__.py
  • (new press) README.md is updated with a 1 liner about the new press in the Available presses section
  • (new press) new press is in the default_presses list in tests/default_presses.py

maxjeblick added 10 commits July 3, 2025 12:38
Signed-off-by: Maximilian Jeblick <maximilianjeblick@gmail.com>
Signed-off-by: Maximilian Jeblick <maximilianjeblick@gmail.com>
Signed-off-by: Maximilian Jeblick <maximilianjeblick@gmail.com>
Signed-off-by: Maximilian Jeblick <maximilianjeblick@gmail.com>
Signed-off-by: Maximilian Jeblick <maximilianjeblick@gmail.com>
Signed-off-by: Maximilian Jeblick <maximilianjeblick@gmail.com>
Signed-off-by: Maximilian Jeblick <maximilianjeblick@gmail.com>
Signed-off-by: Maximilian Jeblick <maximilianjeblick@gmail.com>
Signed-off-by: Maximilian Jeblick <maximilianjeblick@gmail.com>
Signed-off-by: Maximilian Jeblick <maximilianjeblick@gmail.com>
@maxjeblick maxjeblick requested a review from alessiodevoto July 4, 2025 11:49
Signed-off-by: Maximilian Jeblick <maximilianjeblick@gmail.com>
Signed-off-by: Maximilian Jeblick <maximilianjeblick@gmail.com>
Signed-off-by: Maximilian Jeblick <maximilianjeblick@gmail.com>
Signed-off-by: Maximilian Jeblick <maximilianjeblick@gmail.com>
Signed-off-by: Maximilian Jeblick <maximilianjeblick@gmail.com>
Signed-off-by: Maximilian Jeblick <maximilianjeblick@gmail.com>
@maxjeblick maxjeblick requested a review from alessiodevoto July 7, 2025 15:45
@maxjeblick
Copy link
Copy Markdown
Collaborator Author

Thanks for the review, I've updated the docs.

I've also increased version = "0.2.7" to cut a new release.

Copy link
Copy Markdown
Collaborator

@alessiodevoto alessiodevoto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks for updating the docs !

@maxjeblick maxjeblick merged commit 90b5cde into main Jul 7, 2025
3 checks passed
@maxjeblick maxjeblick deleted the max/improve_docs branch July 7, 2025 16:27
@maxjeblick maxjeblick mentioned this pull request Jul 8, 2025
maxjeblick added a commit that referenced this pull request Aug 12, 2025
Signed-off-by: Max Jeblick <maximilianjeblick@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve documentation

2 participants