Skip to content

Reword "how does Julia define its public API" [NFC] #50324

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.

Sign up for GitHub

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

Merged
LilithHafner merged 2 commits into from
Jun 28, 2023
Merged

Reword "how does Julia define its public API" [NFC] #50324

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7565b9f
Reword "how does Julia define its public API" [NFC]
LilithHafner Jun 28, 2023
8701930
Remove trailing whitespace
LilithHafner Jun 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions doc/src/manual/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ On the other hand, language *interoperability* is extremely useful: we want to e

### How does Julia define its public API?

The only interfaces that are stable with respect to [SemVer](https://semver.org/) of Julia
version are the Julia `Base` and standard libraries interfaces described in
[the documentation](https://docs.julialang.org/) and not marked as unstable (e.g.,
experimental and internal). 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 `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_.

### There is a useful undocumented function/type/constant. Can I use it?

Expand Down