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.

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

Enhancements in docstrings and github actions #70

Merged
merged 16 commits into from
Dec 19, 2023
Merged

Enhancements in docstrings and github actions #70

merged 16 commits into from
Dec 19, 2023

Conversation

dmtzs
Copy link
Owner

@dmtzs dmtzs commented Dec 19, 2023

Added more legible documentation to the docstrings of the functions and added more examples about how to use them

Added more legibel documentation to the docstrings of the functions and added mroe examples about how to use them
@dmtzs dmtzs added documentation Improvements or additions to documentation enhancement New feature or request task Only a task, not an issue at all labels Dec 19, 2023
@dmtzs dmtzs self-assigned this Dec 19, 2023
@dmtzs dmtzs marked this pull request as draft December 19, 2023 04:28
Passing from version 4.1.2 to 4.1.1 cause is a revision and not only patching
@dmtzs dmtzs linked an issue Dec 19, 2023 that may be closed by this pull request
Updated checkout action to version 4 and updated setup-python to version 5
@dmtzs dmtzs added the merge Label for PR created label Dec 19, 2023
Changed the file by complete to comply with new updated from github
Updated the supported and not supported versions of the library
@dmtzs dmtzs changed the title Enhancements in docstrings Enhancements in docstrings and github actions Dec 19, 2023
Added better and explicit docstrings to the fuinctions that are internal and extrenal and some pylint corrections
Correction in github action to the triggers of the same one
Changed some http status codes from inst to use the library
@dmtzs dmtzs linked an issue Dec 19, 2023 that may be closed by this pull request
Added a release validation in github action to know if the version is one of the previous ones at least
Now the action should be executed in every pull request
Better handling of the file not found error
@dmtzs dmtzs linked an issue Dec 19, 2023 that may be closed by this pull request
Now pylint runs for all python scripts inside the repo and release action is created to create a release automatically everytime we do a PR successfully
Added all http status codes using the http library
Correction in pylint, so now is only executed inside src and .github folders
Added new line at the end according to pylint
Added module docstring and modified the pylint yml to install all necessary to pass correctly the unable to import error
@dmtzs dmtzs marked this pull request as ready for review December 19, 2023 22:54
@dmtzs dmtzs merged commit 9cf2916 into master Dec 19, 2023
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request merge Label for PR created task Only a task, not an issue at all
Projects
None yet
1 participant