Repository navigation
Conversation
…ocstrings why: libtmux.org draws a class docstring as an API task directory when it holds three or more bold-led paragraphs, each followed by a labelled list of Sphinx roles. The python port had none, so none of the four core types told a reader which call does which job or what it raises. what: - Server, Session, Window and Pane: add bold-led rows in the intro of the class docstring, each followed by a bullet list of `Label: :meth:` roles in the fully qualified `~libtmux.X.y` form - State, from the source, what each group raises (ObjectDoesNotExist, TmuxObjectDoesNotExist, BadSessionName, OptionError, ValueError), which listings answer empty instead of raising, and which flags warn and are ignored on an older tmux - CHANGES: record the documentation change
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #857 +/- ##
=======================================
Coverage 52.09% 52.09%
=======================================
Files 26 26
Lines 3751 3751
Branches 747 747
=======================================
Hits 1954 1954
Misses 1493 1493
Partials 304 304 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Most ports open their Server page on libtmux.org with a task directory; no Python type has one. This adds a directory to the Server, Session, Window and Pane class docstrings, after the opening description and before the numpydoc sections, with fully qualified Sphinx roles.
Changes
src/libtmux/server.py,Server: Connecting; Finding one thing; Listing everything; Filtering; Creating and destroying; Clients; Options, hooks and environment; Buffers and key bindings; Running a command.src/libtmux/session.py,Session: Reading it; Finding it; Finding what is inside; Moving the selection; Adding windows; Changing it; Options, hooks and environment.src/libtmux/window.py,Window: Reading it; Finding it; Finding its neighbours; Splitting and arranging; Linking and moving; Changing it; Options and hooks.src/libtmux/pane.py,Pane: Reading it; Finding it; Finding its parents; Sending input; Reading output; Splitting and arranging; Modes, pipes and history; Changing it; Options and hooks.CHANGES: a Documentation entry.Review notes
Session.refresh()andSession.kill_window()failure behaviour is not stated, since their docstrings do not document it.Test plan
parseApiProseandgroupDirectoryfrom libtmux/docs, after this port's doc parser) folds each new doc comment into a directoryruff checkandruff format --checkpass