Skip to content

[SR-5173] Documentation access from the Swift REPL #4630

Open
@swift-ci

Description

@swift-ci
Previous ID SR-5173
Radar None
Original Reporter roope (JIRA User)
Type Improvement

Attachment: Download

Additional Detail from JIRA
Votes 1
Component/s LLDB for Swift
Labels Improvement
Assignee None
Priority Medium

md5: 8fbcb432e9328ba73bf93fce76c20101

Issue Description:

When exploring standard library and the language it self from the REPL.
Users currently need to switch between a browser to read documentation and the
REPL it self.

What I would like to see in the REPL is behaviour like this:

 1> :help print

    print(_:separator:terminator:)
    Writes the textual representations of the given items into the standard output.

    ...

This means somekind of nice textual version of what I find here:
https://developer.apple.com/documentation/swift/1541053-print

I see that in the source code this information is available
(https://github.com/apple/swift/blob/master/stdlib/public/core/Print.swift#L13).

And that in playgrounds I can get this quick help. Would be really nice
to access this from the REPL too.

Attached an example of how the documentation access works from Elixir REPL.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions