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

Documentation improvements #102

Merged
merged 26 commits into from
Jan 4, 2024
Merged

Documentation improvements #102

merged 26 commits into from
Jan 4, 2024

Conversation

pvanliefland
Copy link
Contributor

@pvanliefland pvanliefland commented Dec 14, 2023

Main PR goal: document the codebase using docstrings.

Secondary goal: minor refactoring, typo fixes...

This PR also brings a lot of changes regarding linting & code formatting:

  • Use ruff for code formatting instead of black
  • Add isort rules
  • Add pydocstyle rules to validate docstrings
  • Add pyupgrade rules to automatically upgrade syntax for newer versions of the language

@pvanliefland pvanliefland marked this pull request as draft December 20, 2023 14:22
@pvanliefland pvanliefland marked this pull request as ready for review January 3, 2024 13:11
@cheikhgwane
Copy link
Contributor

Conflit on pyproject.toml @pvanliefland

# Conflicts:
#	pyproject.toml
@pvanliefland
Copy link
Contributor Author

Thanks @cheikhgwane , I've resolved the conflicts

README.md Outdated Show resolved Hide resolved
openhexa/cli/api.py Outdated Show resolved Hide resolved
openhexa/cli/api.py Outdated Show resolved Hide resolved
Copy link
Contributor

@cheikhgwane cheikhgwane left a comment

Choose a reason for hiding this comment

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

LGTM

@pvanliefland pvanliefland merged commit 69366fc into main Jan 4, 2024
4 checks passed
@pvanliefland pvanliefland deleted the docs-improvements branch January 4, 2024 13:31
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.

2 participants