Docs & FAQ #318
Merged
Docs & FAQ #318
Conversation
This file contains 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
g-k
approved these changes
Aug 4, 2020
| @@ -18,7 +18,10 @@ jobs: | |||
| - run: | |||
| name: run tests | |||
| command: | | |||
| make black check_conftest_imports test coverage | |||
| source venv/bin/activate | |||
| # check_conftest_imports currently fails | |||
There was a problem hiding this comment.
this uses ripgrep but could fallback to git grep or something else
| ======= | ||
|
|
||
| .. note:: | ||
| The caching operations is under consideration for deprecation. If you |
| - file, You can obtain one at https://mozilla.org/MPL/2.0/. --> | ||
|
|
||
| ============================ | ||
| Adding a New Service |
ajvb
approved these changes
Aug 4, 2020
| ``resources.py``) are used to supply the data to tests. The tests are | ||
| conventionally written in ``test_<foo>.py`` files, with a single function of the | ||
| same name as the file. *(With "Black_", we stopped the tabs-vs-spaces debate, | ||
| so redirected that energy to one-or-many-tests-per-file debate.)* |
N.B. we require user to have sphinx installed globally at the moment. That is somewhat reasonable, as Rust language uses sphinx for documentation. If we end up wanting specific sphinx extensions, we'll have to add those requirements to a (not yet in existance) requirements-dev.txt.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Replacement for #241, which got totally hosed somehow.
ATM, these docs build as html, but that isn't (yet) in the Makefile or CI. So this is a content only review