Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release preparations #29

Merged
merged 2 commits into from
Mar 16, 2024
Merged

Release preparations #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2a3f7f2
chore: version bump
cpvalente Mar 16, 2024
28ffd77
docs: compatible with micro python
cpvalente Mar 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# StupidArtnet

(Very) Simple Art-Net implementation in Python
(Very) Simple Art-Net implementation in Python (compatible with micro python)

#### Table of Contents
- [Installing from github](#installing-from-github)
Comment on lines 3 to 9
Copy link
Contributor

Choose a reason for hiding this comment

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

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [1-1]

Consider correcting the spelling of "GitHub" to use a capital "H" in the badge URLs to adhere to the official spelling of the platform.

- [![.github/workflows/publish-to-pypi.yml](https://github.com/cpvalente/stupidArtnet/actions/workflows/publish-to-pypi.yml/badge.svg)](https://github.com/cpvalente/stupidArtnet/actions/workflows/publish-to-pypi.yml)
+ [![.github/workflows/publish-to-pypi.yml](https://GitHub.com/cpvalente/stupidArtnet/actions/workflows/publish-to-pypi.yml/badge.svg)](https://GitHub.com/cpvalente/stupidArtnet/actions/workflows/publish-to-pypi.yml)

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [20-20]

Again, correct the spelling of "GitHub" to use a capital "H" in the section title "Installing from github" for consistency.

- ### Installing from github
+ ### Installing from GitHub

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [21-21]

In the instructions for cloning from GitHub, ensure the spelling of "GitHub" uses a capital "H".

- You can get up and running quickly cloning from github.
+ You can get up and running quickly cloning from GitHub.

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [33-33]

The phrase "user defined callback" should be hyphenated when used as an adjective. Consider changing it to "user-defined callback" for grammatical correctness.

- # and return new data to a user defined callback
+ # and return new data to a user-defined callback

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [45-45]

The phrase "at a rate of no less than 30Hz" could be simplified to "at least 30Hz" for clarity and conciseness.

- Usually Artnet devices (and DMX in general) transmit data at a rate of no less than 30Hz.
+ Usually Artnet devices (and DMX in general) transmit data at least 30Hz.

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [74-74]

The phrase "In an effort to help you understand" could be simplified to "To help you understand" for conciseness.
Also, "the packets is build" should be corrected to "the packets are built" for grammatical accuracy.

- I am also doing my best to comment the sections where the packets is build. In an effort to help you understand the protocol and be able to extend it for a more case specific use.
+ I am also doing my best to comment the sections where the packets are built. To help you understand the protocol and be able to extend it for a more case-specific use.

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [82-82]

The sentence "just shove the protocol header into your data array and send it to the right place" should start with a capital letter, and consider adding a comma after "Usually" for clarity.

- just shove the protocol header into your data array and send it to the right place.
+ Just shove the protocol header into your data array and send it to the right place.

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [83-83]

Consider adding commas for clarity: "This is a convention, however, is not forcefully implemented."

- This is a convention however is not forcefully implemented.
+ This is a convention, however, is not forcefully implemented.

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [119-119]

The phrase "I simplified here defaulting to use a 256 value universe" could be improved for clarity by adding a comma: "I simplified here, defaulting to use a 256 value universe."

- I simplified here defaulting to use a 256 value universe.
+ I simplified here, defaulting to use a 256 value universe.

Copy link
Contributor

Choose a reason for hiding this comment

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

The spelling of "GitHub" should use a capital "H" in the Table of Contents for consistency with the official platform name.

- - [Installing from github](#installing-from-github)
+ - [Installing from GitHub](#installing-from-github)
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
- [Installing from github](#installing-from-github)
- [Installing from GitHub](#installing-from-github)

Expand Down
2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

setup(name='stupidArtnet',
author='cpvalente',
version='1.4.0',
version='1.5.0',
license='MIT',
description='(Very) Simple implementation of the Art-Net protocol',
long_description=long_description,
Expand Down
Loading