zulip/docs
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
..
_static travis: Removed screen cast of Travis setup. 2020-06-01 14:12:11 -07:00
_templates compose: Rewrite Zoom video call integration to use OAuth. 2020-06-03 16:39:12 -07:00
contributing docs: Fix typos in contributing/code-style.md. 2020-06-08 11:13:32 -07:00
development docs: Fix setup-advanced git clone instructions. 2020-05-21 13:05:59 -07:00
documentation docs: Fix anchor link written in reference link syntax. 2020-06-01 18:31:05 -07:00
git docs: Fix broken and missing link references in Git guide. 2020-06-01 18:31:05 -07:00
images doc: Updated CircleCI setup documentation. 2020-06-01 14:12:11 -07:00
overview capitalization: Fix OAuth capitalization. 2020-06-03 16:39:12 -07:00
production compose: Rewrite Zoom video call integration to use OAuth. 2020-06-03 16:39:12 -07:00
subsystems docs: Add missing comma. 2020-05-17 21:27:31 -07:00
testing docs: Improve readability of a sentence in testing/philosophy.md. 2020-06-08 11:13:32 -07:00
translating docs: Improve documentation for calling i18n functions. 2020-05-27 13:56:05 -07:00
tutorials python: Convert more variable type annotations to Python 3.6 style. 2020-05-08 16:42:43 -07:00
.gitignore gitignore: Anchor patterns that should be anchored. 2017-07-19 14:03:49 -07:00
code-of-conduct.md repository: Add CODE_OF_CONDUCT.md. 2017-06-14 18:43:08 -07:00
conf.py docs: Avoid deprecated app.add_stylesheet alias. 2020-06-04 14:15:30 -07:00
index.rst docs: Add missing index.rst for documentation/. 2019-05-29 17:54:02 -07:00
Makefile docs: Replace Makefile based on output of newer sphinx-quickstart. 2019-12-02 18:39:33 -08:00
README.md docs: Add README.md to zulip/docs to prevent reading on GitHub. 2018-04-24 10:50:39 -07:00
requirements.readthedocs.txt requirements: Rename requirements files. 2017-11-21 02:38:26 +05:30
THIRDPARTY THIRDPARTY: Add missing license texts for CC-BY-3.0, CC-BY-SA-4.0. 2020-05-02 10:07:55 -07:00

Zulip markdown documentation hosted elsewhere

The markdown files in this directory ( /zulip/docs ) are not intended to be read on GitHub. Instead, visit our ReadTheDocs to read the Zulip documentation.