Skip to content

Commit 67c74fa

Browse files
committed
Fix docs styling
1 parent 935aa8b commit 67c74fa

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

readthedocs/projects/tasks.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -227,22 +227,21 @@ def _log(self, msg):
227227
def run(self, pk, version_pk=None, build_pk=None, record=True,
228228
docker=False, search=True, force=False, localmedia=True, **__):
229229
"""
230-
Run a documentation sync or sync n' build.
230+
Run a documentation sync n' build.
231231
232232
This is fully wrapped in exception handling to account for a number of
233233
failure cases. We first run a few commands in a local build environment,
234234
but do not report on environment success. This avoids a flicker on the
235235
build output page where the build is marked as finished in between the
236236
local environment steps and the docker build steps.
237237
238-
If a failure is raised, or the build is not successful, return ``False``,
239-
otherwise, ``True``.
238+
If a failure is raised, or the build is not successful, return
239+
``False``, otherwise, ``True``.
240240
241241
Unhandled exceptions raise a generic user facing error, which directs
242242
the user to bug us. It is therefore a benefit to have as few unhandled
243243
errors as possible.
244244
245-
246245
:param pk int: Project id
247246
:param version_pk int: Project Version id (latest if None)
248247
:param build_pk int: Build id (if None, commands are not recorded)
@@ -251,7 +250,9 @@ def run(self, pk, version_pk=None, build_pk=None, record=True,
251250
:param search bool: update search
252251
:param force bool: force Sphinx build
253252
:param localmedia bool: update localmedia
253+
254254
:returns: whether build was successful or not
255+
255256
:rtype: bool
256257
"""
257258
try:

0 commit comments

Comments
 (0)