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

Jump to bottom

[SR-3281] The Swift Man Page Is Woefully Out Of Date #45869

Closed
CodaFi opened this issue Nov 27, 2016 · 3 comments
Closed

[SR-3281] The Swift Man Page Is Woefully Out Of Date #45869

CodaFi opened this issue Nov 27, 2016 · 3 comments
Labels
compiler The Swift compiler in itself good first issue Good for newcomers improvement

Comments

@CodaFi
Copy link
Member

CodaFi commented Nov 27, 2016

Previous ID SR-3281
Radar None
Original Reporter @CodaFi
Type Improvement
Status Closed
Resolution Done
Additional Detail from JIRA
Votes 0
Component/s Compiler
Labels Improvement, StarterBug
Assignee contraultra (JIRA)
Priority Medium

md5: ca5847c3757d9b69faea339dda8a8066

Issue Description:

This is our current man page.

swift(1)                    Swift Documentation                    swift(1)

NAME
       swift - the amazingly new programming language

SYNOPSIS
       swift [-help] [input-filename [program-arguments]]

       swiftc [-emit-object|-emit-assembly|-emit-library]
         [-help]
         -o output-file
         input-filenames

       The full list of supported options is available via "swift -help" or
       "swiftc -help".

DESCRIPTION
       Swift is a new, high performance systems programming language.  It
       has a clean and modern syntax, and offers seamless access to
       existing C and Objective-C code and frameworks, and is memory safe
       (by default).

       Although inspired by Objective-C and many other languages, Swift is
       not itself a C-derived language. As a complete and independent
       language, Swift packages core features like flow control, data
       structures, and functions, with high-level constructs like objects,
       protocols, closures, and generics.  Swift embraces modules,
       eliminating the need for headers and the code duplication they
       entail.

swift 3.0.1                      2016-10-11                        swift(1)

While I like to think Swift is still "amazingly new", it has grown in the nearly 2 years since this page was updated and the man page should reflect that with a modern rewrite.
@CodaFi
Copy link
Member Author

CodaFi commented Nov 27, 2016

This branch shows an example of what needs to be done to edit the files that generate this page.

@swift-ci
Copy link
Collaborator

Comment by Geoffrey Wiseman (JIRA)

Maybe this is worth discussion on Swift Evolution about what this man page should look like these days?

@swift-ci
Copy link
Collaborator

Comment by nate (JIRA)

Update to the Swift man page has been merged.

@swift-ci swift-ci transferred this issue from apple/swift-issues Apr 25, 2022
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
compiler The Swift compiler in itself good first issue Good for newcomers improvement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@CodaFi @swift-ci