ExternalVendorCode/tahoe-lafs
1
0
Fork 0
mirror of https://github.com/tahoe-lafs/tahoe-lafs.git synced 2025-02-20 17:52:50 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs(style): Cleanup tab characters in devel guide

Browse Source
This commit is contained in:
Ross Patterson 2020-09-30 06:58:10 -07:00
parent 784ddc5b07
commit f92362b002
1 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
docs/developer-guide.rst
View File

@ -9,36 +9,36 @@ This project is configured for use with `pre-commit <https://pre-commit.com>`_ t
For example::
tahoe-lafs $ pre-commit install
pre-commit installed at .git/hooks/pre-commit
tahoe-lafs $ python -c "import pathlib; pathlib.Path('src/allmydata/tabbed.py').write_text('def foo():\\n\\tpass\\n')"
tahoe-lafs $ git add src/allmydata/tabbed.py
tahoe-lafs $ git commit -a -m "Add a file that violates flake8"
flake8...................................................................Failed
- hook id: flake8
- exit code: 1
tahoe-lafs $ pre-commit install
pre-commit installed at .git/hooks/pre-commit
tahoe-lafs $ python -c "import pathlib; pathlib.Path('src/allmydata/tabbed.py').write_text('def foo():\\n\\tpass\\n')"
tahoe-lafs $ git add src/allmydata/tabbed.py
tahoe-lafs $ git commit -a -m "Add a file that violates flake8"
flake8...................................................................Failed
- hook id: flake8
- exit code: 1
src/allmydata/tabbed.py:2:1: W191 indentation contains tabs
src/allmydata/tabbed.py:2:1: W191 indentation contains tabs
To uninstall::
tahoe-lafs $ pre-commit uninstall
pre-commit uninstalled
tahoe-lafs $ pre-commit uninstall
pre-commit uninstalled
Some find running linters on every commit to be a nuisance. To avoid the checks triggering during commits, but to check before pushing to the CI, install the hook for pre-push instead::
tahoe-lafs $ pre-commit install -t pre-push
pre-commit installed at .git/hooks/pre-push
tahoe-lafs $ git commit -a -m "Add a file that violates flake8"
[3398.pre-commit 29f8f43d2] Add a file that violates flake8
1 file changed, 2 insertions(+)
create mode 100644 src/allmydata/tabbed.py
tahoe-lafs $ git push
flake8...................................................................Failed
- hook id: flake8
- exit code: 1
tahoe-lafs $ pre-commit install -t pre-push
pre-commit installed at .git/hooks/pre-push
tahoe-lafs $ git commit -a -m "Add a file that violates flake8"
[3398.pre-commit 29f8f43d2] Add a file that violates flake8
1 file changed, 2 insertions(+)
create mode 100644 src/allmydata/tabbed.py
tahoe-lafs $ git push
flake8...................................................................Failed
- hook id: flake8
- exit code: 1
src/allmydata/tabbed.py:2:1: W191 indentation contains tabs
src/allmydata/tabbed.py:2:1: W191 indentation contains tabs
error: failed to push some refs to 'github.com:jaraco/tahoe-lafs.git'
error: failed to push some refs to 'github.com:jaraco/tahoe-lafs.git'