GitHub/Anki
1
0
Fork 0
mirror of https://github.com/ankitects/anki.git synced 2025-09-20 23:12:21 -04:00
Code Issues Projects Releases Packages 1 Wiki Activity Actions

minor doc tweaks

Browse source
This commit is contained in:
Damien Elmes 2020-12-09 19:59:06 +10:00
parent 1399ea9f13
commit 5f099e5514
2 changed files with 5 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/contributing.md
View file

@ -36,9 +36,9 @@ using automated tools. At the moment, large parts of the codebase are still
missing type hints, and some of the hints that do exist are incorrect or too missing type hints, and some of the hints that do exist are incorrect or too
general. general.
When running 'make check', Anki uses mypy to typecheck the code. Mypy mostly When running 'bazel test', Anki uses mypy to typecheck the code. Mypy is able to
only checks functions that have type signatures, so adding more type signatures infer some types by itself, but adding more type signatures to the code
to the code increases the amount of code that mypy is able to analyze. increases the amount of code that mypy is able to analyze.
Patches that improve the type hints would be appreciated. And if you're Patches that improve the type hints would be appreciated. And if you're
adding new functionality, please use type hints in the new code you write adding new functionality, please use type hints in the new code you write
@ -113,7 +113,7 @@ If you'd like to keep them up to date, you need to run 'make pull-i18n'
periodically. periodically.
For information on adding new translatable strings to Anki, please see For information on adding new translatable strings to Anki, please see
https://ankitects.github.io/translating/#/anki/developers https://translating.ankiweb.net/#/anki/developers
## Tests Must Pass ## Tests Must Pass
@ -124,7 +124,7 @@ You can do this automatically by adding the following into
#!/bin/bash #!/bin/bash
bazel test //... bazel test //...
If your change is to anki/ and not covered by the existing unit tests, please If your change is non-trivial and not covered by the existing unit tests, please
consider adding a unit test at the same time. consider adding a unit test at the same time.
## Code Style ## Code Style

2
docs/development.md
View file

@ -19,8 +19,6 @@ You will need Python 3.8 or 3.9 installed. If you do not have Python yet, please
see the platform-specific instructions in the "Building from source" section below see the platform-specific instructions in the "Building from source" section below
for more info. for more info.
The instructions below are for Anki 2.1.36+.
**Mac/Linux**: **Mac/Linux**:
``` ```