Repository navigation
Conversation
why: libtmux.org draws a "What is on here" table on the Java Server and Session pages, and the Window and Pane pages had none, so a reader had to scan every member to find how to split, send input or read output. The site folds a bold-led paragraph followed by a references paragraph or a `Label: refs` list into a row, and draws a table from three rows. what: - Add a "What is on here" section to the Window class doc with rows for reading the capture, panes, layout and size, moving and linking, changing the window, options and hooks, and formats and refreshing - Add one to the Pane class doc with rows for reading the capture, sending input, reading output, running and waiting, splitting and arranging, modes, changing the pane, options and hooks, and formats and refreshing - State per row what throws and what is a pure read of the capture, taken from each method's own doc and body
why: libtmux.org draws a "What is on here" table on the Kotlin Server page only. Session, Window and Pane hold most of the operations a reader looks for, and most of those are `suspend` extensions that the member list shows apart from the type. what: - Add a "What is on here" section to the Session, Window and Pane KDoc, in the shape of the Server one: bold-led rows, each followed by a paragraph of references - Link extension functions as `[name][Type.name]`, since several types share names such as kill, refresh and expand - State that a property or plain function reads the capture and every `suspend` extension asks tmux, and that Pane's waits take their own dispatcher
why: libtmux.org shows the Scala Server directory on the scaladsl Server page, which is an opaque type, and the Session, Window and Pane pages had none. Their operations are extensions, so the member list does not group them by job. what: - Add a "What is on here" section to the doc comment of the Session, Window and Pane opaque types, where the Server one lives - Link every operation as `[[Type.name]]`, as the Server directory does for the operations of the other types - State that an operation beyond a pure read of the capture blocks the calling thread, that results are `Vector` and `Option`, and that Pane's waits are cancelled by interrupting the thread
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
Java Server and Session, Kotlin Server and Scala Server open with a task directory on libtmux.org. This writes the missing ones: Java Window and Pane, and Kotlin and Scala Session, Window and Pane, each in the shape that port's existing directory uses.
Changes
Window.javaandPane.javaclass Javadoc:<p><strong>rows, then a{@link #x}paragraph or aLabel:list.Session.kt,Window.ktandPane.ktKDoc. Extension functions are written[kill][Session.kill], since several types share names such as kill, refresh and expand.Session.scala,Window.scalaandPane.scala, where the Server directory lives, with[[Type.name]]references.Review notes
watchText,currentPathText,infoor Sessioncontextequivalents, and Scala has nowatchText; each directory lists only what its port has.[[Pane.kill]]point at extension methods, as the Server directory's[[Session.windows]]does; whether Scaladoc resolves them is unconfirmed.Test plan
parseApiProseandgroupDirectoryfrom libtmux/docs, after this port's doc parser) folds each new doc comment into a directory{@link #x}names a method in its file