Skip to content
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.

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

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

Open
swift-ci opened this issue Jun 9, 2017 · 0 comments
Open

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

swift-ci opened this issue Jun 9, 2017 · 0 comments

Comments

@swift-ci
Copy link

swift-ci commented Jun 9, 2017

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.

@swift-ci swift-ci transferred this issue from apple/swift-issues Apr 25, 2022
@shahmishal shahmishal transferred this issue from apple/swift May 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant