jugmac00
Update documentations
- Fix broken examples.
- Rearrange documentations structures.
- Shorten README.rst
Sorry for multiple incremental commits, This is becouse I am not familiar with the Github work flow.
Now, I think that I ended up.
The errors appears in the pre-commit hooks all are linting errors arising from flake. I can't figure out how to fix them. May be the flake8 settings in may machine is different.
Hey @tabebqena,
Thanks so much for your contribution.
About running the same linter version locally...
You can just run tox -e lint locally - this drives pre-commit and finally flake8 all in the same version, defined in the pre-commit-config.yaml file.
It would be great if you could fix the few remaining issues, otherwise I will do that.
Currently, I have so many urgent things to do in my spare time (building a house), it will take a couple of days until I am able for a full review.
Thanks again! I am really looking forward to get this all integrated.
Thanks for much informative review.
- I didn't recognize the problem of reviewing huge changes till I had finished them :) .
- I had just merged with the ['jugmac00:master', will this cause problem foreword?
I had just merged with the ['jugmac00:master', will this cause problem foreword?
No :-) No worries. All good.
I have not forgotten about this PR, but currently I cannot find the time. Apologies for that. I expect that it will be much better at the beginning of September.
Thanks for your patience. I have finished building my house :-) and I will resume normal open source activities next week with the beginning of https://hacktoberfest.com/
Last thing we need to do is figure out why CI is red - looks like the documentation does not build on RTD. I try to find some time on the weekend to have a look what is going wrong.