Skip to content

Commit

Permalink
remove mention that non-underscored symbols denote public API (JuliaL…
Browse files Browse the repository at this point in the history
  • Loading branch information
KristofferC authored Apr 3, 2021
1 parent c4d66c8 commit 4076e87
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 5 deletions.
3 changes: 0 additions & 3 deletions doc/src/manual/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,9 +142,6 @@ uses (e.g. `a[i]::Int`) than to try to pack many alternatives into one type.
as word separators. Underscores are also used to indicate a combination of concepts ([`remotecall_fetch`](@ref)
as a more efficient implementation of `fetch(remotecall(...))`) or as modifiers.
* functions mutating at least one of their arguments end in `!`.
* use identifiers starting with `_` to
denote functions, macros or variables that should be considered private and not part of a package's
public API.
* conciseness is valued, but avoid abbreviation ([`indexin`](@ref) rather than `indxin`) as
it becomes difficult to remember whether and how particular words are abbreviated.

Expand Down
2 changes: 0 additions & 2 deletions doc/src/manual/variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,5 @@ conventions:
* Functions that write to their arguments have names that end in `!`. These are sometimes called
"mutating" or "in-place" functions because they are intended to produce changes in their arguments
after the function is called, not just return a value.
* Names starting with an underscore denote functions, macros or variables that are only used internally
by a package and are not part of its public API.

For more information about stylistic conventions, see the [Style Guide](@ref).

0 comments on commit 4076e87

Please sign in to comment.