Added documentation for all repl types #52876
Conversation
stevengj
added
docs
|
You'll need to update the branch (merge/rebase master) and update julia/stdlib/REPL/test/repl.jl Lines 1753 to 1757 in f286d44 @testset "Docstrings" begin
@test isempty(Docs.undocumented_names(REPL))
end |
|
Looks like you had a merge problem, and a whole bunch of unrelated commits are now included in this PR. 😢 |
Co-authored-by: Steven G. Johnson <[email protected]>
Co-authored-by: inky <[email protected]>
| """ | ||
| AbstractREPL | ||
|
|
||
| The abstract base type for all REPL implementations in Julia. `AbstractREPL` serves as a blueprint for defining various REPL interfaces. |
There was a problem hiding this comment.
No need to explain what "abstract base type" means — this is standard terminology.
| The abstract base type for all REPL implementations in Julia. `AbstractREPL` serves as a blueprint for defining various REPL interfaces. | |
| The abstract base type for all REPL implementations in Julia. |
|
@Keno should really weigh in here, since he wrote this stuff originally. |
|
|
||
| The abstract base type for all REPL implementations in Julia. `AbstractREPL` serves as a blueprint for defining various REPL interfaces. | ||
|
|
||
| Implementations of `AbstractREPL` must define specific methods that dictate how the REPL reads input, evaluates it, and prints output. |
There was a problem hiding this comment.
Similar to the above, I don't think this is particularly useful either. In general abstract types should either document the interface (which is not really stable here, so probably doesn't make sense) or tell you which concrete type you should choose instead, so some of the feature comparison discussion below might help.
There could also potentially be discussions of the overall REPL architecture (frontend/backend split) or other topics that span across implementations here.
| """ | ||
| BasicREPL | ||
|
|
||
| A mutable struct representing a basic implementation of the Julia REPL (Read-Eval-Print Loop), primarily designed for straightforward and fundamental interactive command execution. |
There was a problem hiding this comment.
The fact that it's a mutable struct is not really relevant. I'm also not sure the docstring as a whole is helpful. Obviously, the BasicREPL type is a basic REPL. The question that the docstring should answer is:
- How do I use this?
- When should I prefer this over other RPEL types
- What are the limitations of this type that the other REPL types do not have.
| This REPL type integrates features such as cursor movement, text editing, command history navigation, auto-completion, and more interactive elements that facilitate a more efficient and user-friendly command-line experience. | ||
| Unlike `BasicREPL`, which provides fundamental REPL functionalities, `LineEditREPL` focuses on a richer and more interactive command-line interface. | ||
| It is particularly suited for environments where extended command-line usability is essential, offering a more sophisticated and feature-rich interface for users who perform complex and frequent interactions with the Julia REPL. | ||
| This REPL type is typically the default in standard Julia installations, reflecting its comprehensive functionality that caters to a wide range of user needs. |
There was a problem hiding this comment.
Should link to the manual section. https://docs.julialang.org/en/v1/stdlib/REPL/
Co-authored-by: Steven G. Johnson <[email protected]>
Part of #52725.