Skip to content

Replace julia with Julia in faq when referring to the language. #50103

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
merged 1 commit into from
Jun 28, 2023
Merged

Replace julia with Julia in faq when referring to the language. #50103

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions doc/src/manual/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ 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`
The only interfaces that are stable with respect to [SemVer](https://semver.org/) of Julia
Copy link
Member

@ViralBShah ViralBShah Jun 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The language feels a bit weird here. Not your edits, but the sentence originally. Anything you can do to craft it better?

Copy link
Member Author

@LilithHafner LilithHafner Jun 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well... I propose to totally write this section in #50105, but the scope of that is way larger than this.

Copy link
Member Author

@LilithHafner LilithHafner Jun 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How does this sound?

Base and standard library functionality described in the documentation, which is not labeled as unstable (such as experimental and internal), is covered by SemVer." Functions, types, and constants are not part of the public API if they are not included in the documentation, even if they have docstrings.

Copy link
Member Author

@LilithHafner LilithHafner Jun 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are separate changes. I'm going to merge this as is, and do the reword in another PR

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
Expand All @@ -36,8 +36,8 @@ a complex non-public API, especially when using it from a stable package, it is
to open an [issue](https://github.com/JuliaLang/julia/issues) or
[pull request](https://github.com/JuliaLang/julia/pulls) to start a discussion for turning it
into a public API. However, we do not discourage the attempt to create packages that expose
stable public interfaces while relying on non-public implementation details of `julia` and
buffering the differences across different `julia` versions.
stable public interfaces while relying on non-public implementation details of Julia and
buffering the differences across different Julia versions.

### The documentation is not accurate enough. Can I rely on the existing behavior?

Expand Down