Skip to content

Fix pydoctor docstring errors #192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jelmer merged 1 commit into from
Mar 12, 2026
Merged

Fix pydoctor docstring errors #192

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions subvertpy/_ra.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2035,9 +2035,9 @@ static PyMethodDef ra_methods[] = {
{ "replay_range", (PyCFunction)ra_replay_range, METH_VARARGS|METH_KEYWORDS,
"S.replay_range(start_rev, end_rev, low_water_mark, cbs, send_deltas=True)\n"
"Replay a range of revisions, reporting them to an update editor.\n"
"cbs is a two-tuple with two callbacks:\n"
"- start_rev_cb(revision, revprops) -> editor\n"
"- finish_rev_cb(revision, revprops, editor)\n"
"cbs is a two-tuple with two callbacks:\n\n"
" - start_rev_cb(revision, revprops) -> editor\n"
" - finish_rev_cb(revision, revprops, editor)\n"
},
{ "do_switch", (PyCFunction)ra_do_switch, METH_VARARGS|METH_KEYWORDS,
"S.do_switch(revision_to_update_to, update_target, recurse, switch_url, update_editor, send_copyfrom_args=False, ignore_ancestry=True)\n" },
Expand Down
18 changes: 5 additions & 13 deletions subvertpy/delta.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,8 @@ def apply_txdelta_window(sbuf, window):
"""Apply a txdelta window to a buffer.

:param sbuf: Source buffer (as bytestring)
:param window: (sview_offset, sview_len, tview_len, src_ops, ops, new_data)
:param sview_offset: Offset of the source view
:param sview_len: Length of the source view
:param tview_len: Target view length
:param src_ops: Operations to apply to sview
:param ops: Ops to apply
:param new_data: Buffer with possible new data
:param window: Tuple of (sview_offset, sview_len, tview_len, src_ops,
ops, new_data)
:return: Target buffer
"""
(sview_offset, sview_len, tview_len, src_ops, ops, new_data) = window
Expand All @@ -57,8 +52,8 @@ def apply_txdelta_window(sbuf, window):
def apply_txdelta_handler_chunks(source_chunks, target_chunks):
"""Return a function that can be called repeatedly with txdelta windows.

:param sbuf: Source buffer
:param target_stream: Target stream
:param source_chunks: Source chunks to join into a buffer
:param target_chunks: Target chunks list to append results to
"""
sbuf = bytes().join(source_chunks)

Expand Down Expand Up @@ -179,10 +174,7 @@ def decode_length(text):
def pack_svndiff_instruction(diff_params):
"""Pack a SVN diff instruction

:param diff_params: (action, offset, length)
:param action: Action
:param offset: Offset
:param length: Length
:param diff_params: Tuple of (action, offset, length)
:return: encoded text
"""
(action, offset, length) = diff_params
Expand Down
2 changes: 1 addition & 1 deletion subvertpy/tests/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -354,7 +354,7 @@ def client_log(self, url, start_revnum, stop_revnum):

:param url: URL to log
:param start_revnum: Start revision of the range to log over
:param start_revnum: Stop revision of the range to log over
:param stop_revnum: Stop revision of the range to log over
:return: Dictionary
"""
r = ra.RemoteAccess(url)
Expand Down
Loading