Open
Conversation
Author
Author
|
@emielsebastiaan any updates here? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This is the first step towards #419 and the maintenance grant linked there.
As outlined in the maintenance grant, this PR is a first change aimed at ensuring code quality and consistency. None of the changes here are semver-breaking.
The actions are updated to use the most recent versions of standard actions. pre-commit is configured to aggregate all linters used in the project. Standard hooks (like end-of-line consistency fixer) will be added in a follow-up PR to keep this one minimal.
Docstring change is an example of correct style to be eventually applied everywhere else - note that it, unlike current docstring format, is correctly parsed by mkdocs and produces a human-readable table in the documentation.
This PR only enables a small subset of ruff rules, more will follow - for example, to ensure that docstrings are up-to-date and refer to correct arguments (as can be seen on
SubstrateInterface.__init__, this is not true as of now).The deployment workflow was tested on testPyPI here: https://github.com/sterliakov/py-polkadot-sdk/actions/runs/16008651302
The next step will be a big PR with
ruff formatenabled (and it, I hope, will be the last PR with a lot of changes batched together).