-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
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
Add public keyword #50105
Add public keyword #50105
Changes from 68 commits
5b3d8c1
665855e
52f519e
03f9e02
7eb64a2
c7192ea
ec3b2f3
804f5ef
7d404f0
4dc10c4
5fd1f64
b85ae46
acc928a
a5162c2
aacc187
145ad7f
aea3d22
f7d57ba
34844bb
8241760
920244a
9e61f96
f75cb68
db7ba05
7dbdd5e
ac11ea4
bd0ee87
1dc9652
17b8834
6e2ddec
1000988
c5955c0
5ed2c7d
5da758e
de8be2b
d75725b
05352df
4b04f31
051f824
8a56ab4
6e2d809
69cf8d4
9d74beb
4b18e1d
4ba71ab
ce3a798
ca8eb44
6d1e2c7
2678523
528469b
082fb86
3d09dae
12bab72
0112e2c
66427c6
067d69c
b688b60
6ce6fdb
e57c63f
1a6e3dc
ebcdf24
d4418fe
c4924c9
5835699
153b538
158d59f
41f3729
fd5fb90
ea7a141
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
JULIASYNTAX_BRANCH = main | ||
JULIASYNTAX_SHA1 = 045d156c44dbb87769c7416d049a7c08908539d4 | ||
JULIASYNTAX_SHA1 = a9110fa8ecbe79943bb9525b4ccd99a3976cfcb7 | ||
JULIASYNTAX_GIT_URL := https://github.com/JuliaLang/JuliaSyntax.jl.git | ||
JULIASYNTAX_TAR_URL = https://api.github.com/repos/JuliaLang/JuliaSyntax.jl/tarball/$1 |
This file was deleted.
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
a42bbb42babbbd727556f6bc01455826 |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
d542766e72b57418b9b4e17743f89d8535c1f36497346b57538bd0cb451e64af9493015692179f80ec4ee8cf18349c1e0888f5710db895e19f9bb0322f0f7464 |
LilithHafner marked this conversation as resolved.
Show resolved
Hide resolved
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -22,11 +22,28 @@ On the other hand, language *interoperability* is extremely useful: we want to e | |
|
||
### How does Julia define its public API? | ||
|
||
Julia `Base` and standard library functionality described in the | ||
[the documentation](https://docs.julialang.org/) that is not marked as unstable | ||
(e.g. experimental and internal) is covered by [SemVer](https://semver.org/). | ||
Functions, types, and constants are not part of the public API if they are not | ||
included in the documentation, _even if they have docstrings_. | ||
Julia's public [API](https://en.wikipedia.org/wiki/API) is the behavior described in | ||
documentation of public symbols from `Base` and the standard libraries. Functions, | ||
types, and constants are not part of the public API if they are not public, even if | ||
they have docstrings or are described in the documentation. Further, only the documented | ||
behavior of public symbols is part of the public API. Undocumented behavior of public | ||
symbols is internal. | ||
Comment on lines
+25
to
+30
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There are still some symbols which are documented in the manual and not yet marked as public (e.g. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I sorta responded to this way up the thread: #50105 (comment) The plan is to find them all by 1.11. #51335. |
||
|
||
Public symbols are those marked with either `public foo` or `export foo`. | ||
|
||
In other words: | ||
|
||
- Documented behavior of public symbols is part of the public API. | ||
- Undocumented behavior of public symbols is not part of the public API. | ||
- Documented behavior of private symbols is not part of the public API. | ||
- Undocumented behavior of private symbols is not part of the public API. | ||
|
||
You can get a complete list of the public symbols from a module with `names(MyModule)`. | ||
|
||
Package authors are encouraged to define their public API similarly. | ||
|
||
Anything in Julia's Public API is covered by [SemVer](https://semver.org/) and therefore | ||
will not be removed or receive meaningful breaking changes before Julia 2.0. | ||
|
||
### There is a useful undocumented function/type/constant. Can I use it? | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo ("available available")?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
#51334