Commit Graph

42 Commits

Author SHA1 Message Date
Josh Soref
0213f2dd88 Spelling docs (#42437)
* spelling: any

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: associated

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: async

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: classes

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: clonability

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: conspicuously

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: constituent

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: constraint

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: contains

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: definition

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: digestible

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: for

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: github

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: javascript

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: manually

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: much

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: multi

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: occasionally

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: outputs

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: overriding

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: partition

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: propagation

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: protocol

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: quandary

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: redundant

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: responsible

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: right

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: specifically

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: suppose

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: that

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: the

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: with

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

Co-authored-by: Josh Soref <jsoref@users.noreply.github.com>
2022-04-19 14:04:59 -07:00
Karoy Lorentey
b6f0b6da3b [stdlib][docs] Describe availability macros in the stdlib programmer's manual 2021-10-28 19:10:28 -07:00
Karoy Lorentey
87cfcb8e1a [doc][stdlib] Minor edits 2021-10-06 14:59:18 -07:00
Karoy Lorentey
8663f07dd7 Apply edits in review
Co-authored-by: Guillaume Lessard <glessard@users.noreply.github.com>
2021-10-06 14:39:20 -07:00
Karoy Lorentey
1527cc7f08 [doc][stdlib] Apply review notes, expanding on description 2021-10-06 12:05:37 -07:00
Karoy Lorentey
d40c03f4bd [doc][stdlib] Tiny edits 2021-10-05 22:27:34 -07:00
Karoy Lorentey
e32db08319 [doc][stdlib] Expand the coding style section of the stdlib programmers manual
- Explain why we have such a short line length limit
- Expand a bit on line breaking conventions
- Add a section on how to present type definitions
2021-10-05 22:06:06 -07:00
Karoy Lorentey
6789441f15 [stdlib][doc] Update stdlib manual to reflect new availability guidelines 2021-09-22 12:24:53 -07:00
Slava Pestov
c997016bc6 Update some docs to talk about 'main' instead of 'master'
Fixes https://bugs.swift.org/browse/SR-14015 / rdar://problem/72819056
2021-01-11 22:57:51 -05:00
Mishal Shah
40024718ac Update doc and links to support new main branch 2020-09-22 23:53:29 -07:00
Bradley Mackey
96a0962c9c [docs] stdlib guide - fix legacy naming
_sanityCheck is now called _internalInvariant
2020-06-18 14:36:28 +01:00
Robert Widmann
00b46f3653 [Gardening] De-RST TransparentAttr 2020-05-02 05:22:04 -07:00
Valeriy Van
de9c28cb41 Update StandardLibraryProgrammersManual.md
Suggestion of @xwu in PR #31150 after it was already merged
2020-04-24 13:33:29 +02:00
Valeriy Van
97c9b71f9d Fixes info about internal _FixedArray16 in StandardLibraryProgrammersManual.md 2020-04-20 12:47:01 +02:00
Karoy Lorentey
2c61f00819 [doc] Update based on feedback; add short section on availabilty 2020-04-07 15:31:33 -07:00
Karoy Lorentey
aadd5ef1bb Merge branch 'master' into stdlib-guide-update 2020-01-15 16:55:18 -08:00
Varun Gandhi
2488f4801c [docs] Add a DevelopmentTips.md file. (#28248) 2019-11-18 10:39:14 -08:00
Karoy Lorentey
ef93be28a9 Update StandardLibraryProgrammersManual.md 2019-08-07 17:40:45 -07:00
Andrew Trick
0b3255fe2c Correct my minor typo in the stdlib programmer guide. 2019-08-02 17:14:27 -07:00
Andrew Trick
e75f551268 Add unsafeBitCast documentation to the Standard Library Programmer's Guide
Explaining the many other ways that one can cast references.
2019-07-17 19:40:25 -07:00
Karoy Lorentey
649b2db14e Start merging information from AccessControlInStdlib.rst 2019-07-17 17:18:20 -07:00
Karoy Lorentey
9eb943b9f3 Update StandardLibraryProgrammersManual.md 2019-07-11 19:29:36 -07:00
Karoy Lorentey
01f3d290cc Typo fix 2019-06-27 14:52:05 -07:00
Karoy Lorentey
bf57cdca3f [doc] Add an embryonic section on stdlib coding style 2019-06-26 17:29:24 -07:00
Bob Wilson
ef1d9bc7f8 Stop using the _branchHint function
LLVM r355981 changed various intrinsic functions, including expect,
to require immediate arguments. Swift's _branchHint function has an
expected value that is passed in as an argument, so that it cannot
use LLVM's expect intrinsic. The good news is that _branchHint is only
ever used with immediate arguments, so we can just move the intrinsic
into _fastPath and _slowPath and use those instead of _branchHint.

As was noted in the documentation, the _fastPath and _slowPath names are
confusing but we have passed the point where we can simply rename them.
We could add new names but would still need to keep the old ones around
for binary compatibility, and it is not clear that it is worth the
trouble. I have removed that note from the documentation.
2019-03-17 22:13:51 -07:00
Jordan Rose
ef04b24136 [docs] Describe the Curiously Recursive Inlinable Switch Pattern (#22643) 2019-02-19 10:33:14 -08:00
Michael Ilseman
2c550d0220 _sanityCheck is now _internalInvariant 2018-12-10 11:17:52 -08:00
Erik Eckstein
c6eb5fe82a minor follow-ups for remove pinning in utilities and docs 2018-08-25 11:14:18 -07:00
Slava Pestov
e1f50b2d36 SE-0193: Rename @_inlineable to @inlinable, @_versioned to @usableFromInline 2018-03-30 21:55:30 -07:00
Michael Ilseman
977a0e0d86 [docs] Add productivity hacks to stdlib progman (#15403)
[docs] Add productivity hacks to stdlib prog man

Small section about using ninja to more efficiently work on the standard library.
2018-03-24 16:22:27 -07:00
John Eismeier
6cfc648d2a Fix spacing 2018-02-16 15:00:59 -05:00
John Eismeier
09452396cc Propose fixing some typos 2018-02-15 14:37:51 -05:00
Greg Parker
da14cd79a6 [runtime] Clean up symbol exports in libc functions. (#13202) 2017-12-01 17:49:11 -08:00
Michael Ilseman
9d444aefd9 [docs] stdlib prog-man: Document @_silgen_name use (#12125)
Add a description of `@_silgen_name` to the standard library programmer's manual.
2017-09-27 17:18:03 -07:00
Michael Ilseman
15a8403f33 Update StandardLibraryProgrammersManual.md
Document @unsafe_no_objc_tagged_pointer
2017-09-12 15:28:09 -07:00
Michael Ilseman
fc8cbc4750 [docs] Additions/structure for stdlib programmer's manual
Flesh out more sections of the manual, restructure the wants and TODOs.
2017-08-18 17:56:25 -07:00
Michael Ilseman
c6da08a384 [docs] Document _unsafelyUnwrappedUnchecked 2017-08-07 13:22:20 -07:00
Michael Ilseman
a078f7f715 [docs] Document @_transparent in stdlib manual 2017-08-07 13:05:01 -07:00
Michael Ilseman
461f66da01 [docs] document _fixLifetime 2017-08-04 11:55:21 -07:00
Michael Ilseman
e29916dbca [docs] Documentation for stdlib precondition checking 2017-08-04 11:32:10 -07:00
Michael Ilseman
02dcd8aa9d [docs] Describe _fastPath et al. 2017-08-04 11:32:10 -07:00
Michael Ilseman
bce472be1b [docs] Initial (empty) standard library programmer's guide 2017-08-04 11:32:10 -07:00