Commit Graph

275 Commits

Author SHA1 Message Date
Robert Widmann
72da97069e Expunge validateDecl from documentation 2019-10-17 16:11:41 -07:00
Sergej Jaskiewicz
8454cbd17a [docs] Modernize Concurrency.rst
Edit code examples according to Swift API guidelines
2019-05-06 15:48:31 +03:00
Gwynne Raskind
687585eafa Docs: Remove all references to long-unused LitRe tool. Also incidentally removes redundant/duplicate check for sphinx-build binary. 2019-01-13 21:15:56 -06:00
Felix Wehnert
2c3ce9b5ba Fixed typo in example code 2018-09-15 18:24:04 +02:00
Erik Little
863f3a19ff Rename @effects to @_effects
@effects is too low a level, and not meant for general usage outside
the standard library. Therefore it deserves to be underscored like
other such attributes.
2018-06-06 12:53:03 -04:00
Daniel Jalkut
56b314f741 Fix documentation build (#9980)
* Fix a documentation build failure caused by missing _ underscore in footnote citation.

* Get archive/LangRef.html building again. I'm not sure this is the most desirable way to address the failure to locate archive/LangRef.html but I confirmed this causes the desired _build/html/archive/LangRef.html to be created when making docs.
2017-05-30 10:50:03 -07:00
Andrew Trick
df6e927147 Documentation: move the @_specialize discussion into
proposals/UnsupportedOptimizationAttributes.rst.
2017-05-19 12:59:49 -07:00
Ziya Suzen - Maxwell Troy
1c5a26129d Fixed typo 2017-01-17 14:33:19 +00:00
practicalswift
3918d9d251 [gardening] Replace likely word processor artefacts with ASCII equivalents (— → --, … → ...) 2017-01-08 15:23:06 +01:00
practicalswift
6d1ae2a39c [gardening] 2016 → 2017 2017-01-06 16:41:22 +01:00
practicalswift
797b80765f [gardening] Use the correct base URL (https://swift.org) in references to the Swift website
Remove all references to the old non-TLS enabled base URL (http://swift.org)
2016-11-20 17:36:03 +01:00
practicalswift
f44686d825 [gardening] Fix trailing whitespace in *.cfg.in, *.html, *.mm and *.sil files 2016-10-29 14:06:43 +02:00
practicalswift
cc852042c9 [gardening] Fix accidental trailing whitespace. 2016-10-29 10:22:58 +02:00
practicalswift
fa7fbdb8b0 [gardening] Remove redundant nil-initialization of optional variable
From the Swift documentation:

"If you define an optional variable without providing a default value,
 the variable is automatically set to nil for you."
2016-09-18 07:40:07 +02:00
practicalswift
89276cc07e [gardening] Replace "a NSFoo" with "an NSFoo". 2016-09-16 21:49:18 +02:00
Jordan Rose
ca14c36936 [docs] Fix syntax highlighting issues to support newer Sphinxes. (#4283)
- Update the Pygments lexer we use for parsing Swift-like code.
- State more explicitly which highlighting should be used in which
  code blocks.
- Disable highlighting altogether in certain cases (such as SIL.rst,
  which has equal amounts grammar and SIL excerpts).

This should fix the warnings-as-error issues coming from Sphinx > 1.3.4.

Based on a patch by Jeremy Fergason!

https://bugs.swift.org/browse/SR-620
2016-08-12 22:59:11 -07:00
Andrew Trick
a18d490d6a Migrate from UnsafePointer<Void> to UnsafeRawPointer. (#3773)
* Migrate from `UnsafePointer<Void>` to `UnsafeRawPointer`.

As proposed in SE-0107: UnsafeRawPointer.

`void*` imports as `UnsafeMutableRawPointer`.
`const void*` imports as `UnsafeRawPointer`.

Occurrences of `UnsafePointer<Void>` are replaced with UnsafeRawPointer.

* Migrate overlays from UnsafePointer<Void> to UnsafeRawPointer.

This requires explicit memory binding in several places,
particularly in NSData and CoreAudio.

* Fix a bunch of test cases for Void->Raw migration.

* qsort takes IUO values

* Bridge `Unsafe[Mutable]RawPointer as `void [const] *`.

* Parse #dsohandle as UnsafeMutableRawPointer

* Update a bunch of test cases for Void->Raw migration.

* Trivial fix for the SceneKit test case.

* Add an UnsafeRawPointer self initializer.

This is unfortunately necessary for assignment between types imported from C.

* Tiny simplification of the initializer.
2016-07-26 14:21:15 -07:00
Andrew Trick
0ed9ee8dee Revert "Migrate from UnsafePointer<Void> to UnsafeRawPointer. (#3724)"
This reverts commit ece0951924.

This results in lldb failues on linux that I can't readily debug.
Backing out until they can be resolved.
2016-07-26 02:50:57 -07:00
Andrew Trick
ece0951924 Migrate from UnsafePointer<Void> to UnsafeRawPointer. (#3724)
* Migrate from `UnsafePointer<Void>` to `UnsafeRawPointer`.

As proposed in SE-0107: UnsafeRawPointer.

`void*` imports as `UnsafeMutableRawPointer`.
`const void*` imports as `UnsafeRawPointer`.

Occurrences of `UnsafePointer<Void>` are replaced with UnsafeRawPointer.

* Migrate overlays from UnsafePointer<Void> to UnsafeRawPointer.

This requires explicit memory binding in several places,
particularly in NSData and CoreAudio.

* Fix a bunch of test cases for Void->Raw migration.

* qsort takes IUO values

* Bridge `Unsafe[Mutable]RawPointer as `void [const] *`.

* Parse #dsohandle as UnsafeMutableRawPointer

* Update a bunch of test cases for Void->Raw migration.

* Trivial fix for the SceneKit test case.

* Add an UnsafeRawPointer self initializer.

This is unfortunately necessary for assignment between types imported from C.

* Tiny simplification of the initializer.
2016-07-26 02:18:21 -07:00
Nate Cook
d7ee56088f [stdlib] Implement partition API change (SE-0120) 2016-07-21 10:16:54 -05:00
Robert Widmann
f97e5dcb0e [SE-0115][1/2] Rename *LiteralConvertible protocols to ExpressibleBy*Literal. This
change includes both the necessary protocol updates and the deprecation
warnings
suitable for migration.  A future patch will remove the renamings and
make this
a hard error.
2016-07-12 15:25:24 -07:00
Doug Gregor
823c24b355 [SE-0112] Rename ErrorProtocol to Error.
This is bullet (5) of the proposed solution in SE-0112, and the last
major piece to be implemented.
2016-07-12 10:53:52 -07:00
Austin Zheng
592c45fddb [gardening] Adding note clarifying status of Concurrency.rst 2016-06-04 11:44:31 -07:00
Joe Groff
73841a643c Accessors.rst: Feedback from @gregtitus and @rjmccall 2016-05-27 14:38:55 -07:00
Dave Abrahams
260e3bfd47 Fix typo 2016-05-27 13:52:21 -07:00
Joe Groff
ea8ab58f18 Extend Accessors doc with tentative getForMutation design.
The intent here is to expose an internal mechanism to the standard library in order to allow it to take advantage of the runtime's "pinning" mechanism to enable efficient divide-and-conquer mutation using slices.
2016-05-27 11:29:38 -07:00
practicalswift
5a3067e24e [gardening] Fix plural issues. 2016-05-21 18:45:31 +02:00
practicalswift
c2107f456c [gardening] "[ a, b ]" → "[a, b]" (#2227) 2016-04-17 21:02:18 +02:00
Hitster GTD
d95921e5a8 [doc] Fix broken links, permanent redirects and Rust-related inconsistencies (#2220)
* Fix almost every broken link and perm redirect

- Fix Xref from OptimizationTips.rst to Specialization section in Generics.rst
to use Sphinx syntax instead of a direct link to GitHub
- Fix over 12 broken links and permanent redirects

* Fix Rust related inconsistencies and broken links

- Update to reflect Rust does not have three types of pointers anymore
- Replace broken links to deprecated Rust documentation with alternatives,
comparable references in new Rust documentation
2016-04-17 20:52:29 +02:00
practicalswift
050023060a [gardening] Fix inconsistent spacing. 2016-04-15 21:05:52 +02:00
practicalswift
c760f6dfbf [gardening] Add whitespace: "foo,bar" → "foo, bar" 2016-04-12 22:31:46 +02:00
practicalswift
fa40ad2f0c [gardening] "Objective C" → "Objective-C" 2016-04-09 12:22:18 +02:00
practicalswift
1ef6ea8c4c [gardening] \t → " " 2016-04-08 21:59:13 +02:00
Manav Gabhawala
7928140f79 [SE-0046] Implements consistent function parameter labels by discarding extraneous parameter names and adding _ where necessary 2016-04-06 20:21:58 -04:00
practicalswift
abfecfde17 [gardening] if ([space]…[space]) → if (…), for(…) → for (…), while(…) → while (…), [[space]x, y[space]] → [x, y] 2016-04-04 16:22:11 +02:00
practicalswift
798877ae77 [gardening] "if (foo)[SPACE][SPACE]{" → "if (foo)[SPACE]{" 2016-04-03 22:57:05 +02:00
Manav Gabhawala
ae929ee61b [CHANGELOG][Docs] Update CHANGELOG and Docs to reflect new parsing of function parameter attributes like 'var', 'let' and 'inout' for SE-0003, SE-0031 and SE-0053 2016-03-29 17:06:23 -04:00
Dmitri Gribenko
f0633ce5a9 stdlib: Sequence.iterator() => .makeIterator() 2016-02-23 13:52:30 -08:00
Dmitri Gribenko
0f36bec31f Merge remote-tracking branch 'origin/master' into swift-3-api-guidelines 2016-02-18 16:41:35 -08:00
practicalswift
5d24d87d81 [gardening] Use consistent naming of .rst files in docs/ ("CamelCase.rst")
Fix some cases where "Camel Case.rst" is used instead of "CamelCase.rst".

File counts:
* Files in repo: 10 242
* Files in repo with spaces in file name: 10
* Files in repo with .rst suffix: 74
* Files in repo with .rst suffix and spaces in file name: 10

In addition to the consistency argument: spaces in file names create unnecessary
gotchas when it comes to bash scripting - see below.

Before this commit:

```
$ find . -name "*.rst" | xargs ls -dl > /dev/null
ls: cannot access ./docs/Dependency: No such file or directory
ls: cannot access Analysis.rst: No such file or directory
ls: cannot access ./docs/proposals/ObjC: No such file or directory
ls: cannot access Interoperation.rst: No such file or directory
ls: cannot access ./docs/proposals/C: No such file or directory
ls: cannot access Pointer: No such file or directory
ls: cannot access Argument: No such file or directory
ls: cannot access Interop.rst: No such file or directory
ls: cannot access ./docs/proposals/archive/Memory: No such file or directory
ls: cannot access and: No such file or directory
ls: cannot access Concurrency: No such file or directory
ls: cannot access Model.rst: No such file or directory
ls: cannot access ./docs/proposals/C: No such file or directory
ls: cannot access Pointer: No such file or directory
ls: cannot access Interop: No such file or directory
ls: cannot access Language: No such file or directory
ls: cannot access Model.rst: No such file or directory
ls: cannot access ./docs/proposals/rejected/Bridging: No such file or directory
ls: cannot access Container: No such file or directory
ls: cannot access Protocols: No such file or directory
ls: cannot access to: No such file or directory
ls: cannot access Class: No such file or directory
ls: cannot access Clusters.rst: No such file or directory
ls: cannot access ./docs/archive/Namespace: No such file or directory
ls: cannot access Level: No such file or directory
ls: cannot access Vars: No such file or directory
ls: cannot access and: No such file or directory
ls: cannot access Top: No such file or directory
ls: cannot access Level: No such file or directory
ls: cannot access Code.rst: No such file or directory
ls: cannot access ./docs/archive/Objective-C: No such file or directory
ls: cannot access Interoperability.rst: No such file or directory
ls: cannot access ./docs/Pattern: No such file or directory
ls: cannot access Matching.rst: No such file or directory
ls: cannot access ./docs/Failable: No such file or directory
ls: cannot access Initializers.rst: No such file or directory
$
```

After this commit:

```
$ find . -name "*.rst" | xargs ls -dl > /dev/null
$
```
2016-02-18 10:46:53 +01:00
Max Moiseev
61c837209b Merge remote-tracking branch 'origin/master' into swift-3-api-guidelines 2016-02-04 16:13:39 -08:00
practicalswift
71e00fefa1 [gardening] Fix typos: "word word" (two spaces) → "word word" (one space) 2016-01-24 21:27:16 +01:00
practicalswift
4b0571bae8 [gardening] Fix documentation typos 2016-01-24 12:52:01 +01:00
Nadav Rotem
193a285453 [Compression] Remove the compression prototype. 2016-01-20 17:08:41 -08:00
Doug Gregor
7d70b704e4 Merge commit '5e11e3f7287427d386636a169c4065c0373931a8' into swift-3-api-guidelines 2016-01-19 23:18:20 -08:00
Tomohiro Kumagai
473b15648a [docs] Replace old-style array type annotations. 2016-01-13 04:09:39 +09:00
Dmitri Gribenko
f0d294b714 Merge pull request #884 from practicalswift/apostrophes
[gardening] Replace left/right quotation marks
2016-01-11 20:41:24 -08:00
Max Moiseev
08e1e4a043 Merge remote-tracking branch 'origin/master' into swift-3-api-guidelines 2016-01-11 16:51:11 -08:00
Tomohiro Kumagai
01155076fa [stdlib] [docs] Modify Array's type parameter name and rename Slice to ArraySlice in comments.
In swift 1.2, `Slice` has been renamed  `ArraySlice`.
In swift 2.0, type parameter name of `Array` is changed from `T` to `Element`.
Therefore, modified the names which appear in code comments and a document.
2016-01-11 17:04:45 +09:00
Dmitri Gribenko
b5d5d82576 Merge pull request #935 from EZ-NET/correct_document_set-type-parameter-name
[stdlib] [docs] Modify Set's type parameter name in comments.
2016-01-10 23:19:50 -08:00