zulip/docs/testing
Sharif Naas 37be21cebe docs: Improve readability of a sentence in testing/philosophy.md.
Previously, it was unnecessarily difficult to parse the sentence to
determine that "HTTP response" and "internal state of the server
following the request" are the coherent ideas. Even if length wasn't
an issue, e.g. "... and checking both the A and B are correct", the
sentence still feels a bit fragile without a "that".

Since the second phrase is indeed relatively long, and "internal state
of the server" is a reasonable guess for the second coherent idea, the
"the" helps to reset the reader's expectation about where the next
coherent idea starts, and ends.

Lastly, having "both" in front of the two phrases encourages an
assumption that they're shorter (which is especially problematic for
the second phrase), while having it at the end of the sentence helps
to anchor the end of the second phrase; this is especially true since
the absence of "both" before that point encourages an assumption that
you haven't finished reading yet, given that two things have been
mentioned.
2020-06-08 11:13:32 -07:00
..
continuous-integration.md circleci: Drop -python3.X suffixes from job names. 2020-06-08 11:04:40 -07:00
index.rst docs: Add an article explaining our testing philosophy. 2020-02-03 16:32:35 -08:00
linters.md docs: Use consistent spelling of CircleCI. 2020-04-28 11:26:58 -07:00
manual-testing.md settings: Reword setting name in settings menu. 2020-03-24 10:47:00 -07:00
mypy.md python: Convert more variable type annotations to Python 3.6 style. 2020-05-08 16:42:43 -07:00
philosophy.md docs: Improve readability of a sentence in testing/philosophy.md. 2020-06-08 11:13:32 -07:00
testing-with-casper.md docs: Convert many http URLs to https. 2020-03-26 21:35:32 -07:00
testing-with-django.md tests: Use do_change_user_role in lint rules and test docs. 2020-05-27 15:38:25 -07:00
testing-with-node.md docs: Fix typo in testing-with-node.md. 2020-05-28 18:55:40 +00:00
testing.md docs: Fix some typos in documentation (most of them found and fixed by codespell). 2020-03-17 05:57:10 -07:00
typescript.md docs: Reduce the number of apparently broken links on github. 2019-10-07 12:08:27 -07:00