Skip to content

Commit fede931

Browse files
committed
Issue #503 docs: avoid bad rst with openeo_processon undocumented functions
make sure there are enough empty lines between `seealso` and `rtype` from `sphinx_autodoc_typehints` plugin
1 parent ba433de commit fede931

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

openeo/internal/documentation.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ def openeo_process(f: Optional[T] = None, process_id: Optional[str] = None, mode
3434

3535
process_id = process_id or f.__name__
3636
url = f"https://processes.openeo.org/#{process_id}"
37-
seealso = f'.. seealso:: openeo.org documentation on `process "{process_id}" <{url}>`_.'
38-
f.__doc__ = textwrap.dedent(f.__doc__ or "") + "\n\n" + seealso
37+
seealso = f'.. seealso::\n openeo.org documentation on `process "{process_id}" <{url}>`_.\n'
38+
f.__doc__ = textwrap.dedent(f.__doc__ or "") + "\n\n" + seealso + "\n\n"
3939

4040
_process_registry[process_id].append((f, mode))
4141
return f

0 commit comments

Comments
 (0)