Skip to content

Commit 7f4e170

Browse files
KristofferCKristofferCclaude
authored
Fix typos and inconsistencies in documentation (#4315)
Co-authored-by: KristofferC <[email protected]> Co-authored-by: Claude <[email protected]>
1 parent 98098f2 commit 7f4e170

File tree

9 files changed

+16
-16
lines changed

9 files changed

+16
-16
lines changed

docs/src/artifacts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ This is deduced automatically by the `artifacts""` string macro, however, if you
230230
!!! compat "Julia 1.7"
231231
Pkg's extended platform selection requires at least Julia 1.7, and is considered experimental.
232232

233-
New in Julia 1.6, `Platform` objects can have extended attributes applied to them, allowing artifacts to be tagged with things such as CUDA driver version compatibility, microarchitectural compatibility, julia version compatibility and more!
233+
New in Julia 1.7, `Platform` objects can have extended attributes applied to them, allowing artifacts to be tagged with things such as CUDA driver version compatibility, microarchitectural compatibility, julia version compatibility and more!
234234
Note that this feature is considered experimental and may change in the future.
235235
If you as a package developer find yourself needing this feature, please get in contact with us so it can evolve for the benefit of the whole ecosystem.
236236
In order to support artifact selection at `Pkg.add()` time, `Pkg` will run the specially-named file `<project_root>/.pkg/select_artifacts.jl`, passing the current platform triplet as the first argument.

docs/src/basedocs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ EditURL = "https://github.com/JuliaLang/Pkg.jl/blob/master/docs/src/basedocs.md"
44

55
# Pkg
66

7-
Pkg is Julia's builtin package manager, and handles operations
7+
Pkg is Julia's built-in package manager, and handles operations
88
such as installing, updating and removing packages.
99

1010
!!! note

docs/src/compatibility.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The format of the version specifier is described in detail below.
2222
The rules below apply to the `Project.toml` file; for registries, see [Registry Compat.toml](@ref).
2323

2424
!!! info
25-
Note that registration into Julia's General Registry requires each dependency to have a `[compat`] entry with an upper bound.
25+
Note that registration into Julia's General Registry requires each dependency to have a `[compat]` entry with an upper bound.
2626

2727
## Version specifier format
2828

docs/src/creating-packages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ just as public as those marked as public with the `export` keyword, but when fol
127127
`YourPackage.that_symbol`.
128128

129129
Let's say we would like our `greet` function to be part of the public API, but not the
130-
`greet_alien` function. We could the write the following and release it as version `1.0.0`.
130+
`greet_alien` function. We could then write the following and release it as version `1.0.0`.
131131

132132
```julia
133133
module HelloWorld

docs/src/environments.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The following discusses Pkg's interaction with environments. For more on the rol
44

55
## Creating your own environments
66

7-
So far we have added packages to the default environment at `~/.julia/environments/v1.9`. It is however easy to create other, independent, projects.
7+
So far we have added packages to the default environment at `~/.julia/environments/v1.10`. It is however easy to create other, independent, projects.
88
This approach has the benefit of allowing you to check in a `Project.toml`, and even a `Manifest.toml` if you wish, into version control (e.g. git) alongside your code.
99
It should be pointed out that when two projects use the same package at the same version, the content of this package is not duplicated.
1010
In order to create a new project, create a directory for it and then activate that directory to make it the "active project", which package operations manipulate:
@@ -117,12 +117,12 @@ between several incompatible packages.
117117

118118
## Shared environments
119119

120-
A "shared" environment is simply an environment that exists in `~/.julia/environments`. The default `v1.9` environment is
120+
A "shared" environment is simply an environment that exists in `~/.julia/environments`. The default `v1.10` environment is
121121
therefore a shared environment:
122122

123123
```julia-repl
124124
(@v1.10) pkg> st
125-
Status `~/.julia/environments/v1.9/Project.toml`
125+
Status `~/.julia/environments/v1.10/Project.toml`
126126
```
127127

128128
Shared environments can be activated with the `--shared` flag to `activate`:
@@ -167,9 +167,9 @@ with its dependencies.
167167
```julia-repl
168168
(@v1.10) pkg> add Images
169169
Resolving package versions...
170-
Updating `~/.julia/environments/v1.9/Project.toml`
170+
Updating `~/.julia/environments/v1.10/Project.toml`
171171
[916415d5] + Images v0.25.2
172-
Updating `~/.julia/environments/v1.9/Manifest.toml`
172+
Updating `~/.julia/environments/v1.10/Manifest.toml`
173173
...
174174
Precompiling environment...
175175
Progress [===================> ] 45/97

docs/src/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,8 +101,8 @@ For more information about managing packages, see the [Managing Packages](@ref M
101101

102102
Up to this point, we have covered basic package management: adding, updating, and removing packages.
103103

104-
You may have noticed the `(@v1.9)` in the REPL prompt.
105-
This lets us know that `v1.9` is the **active environment**.
104+
You may have noticed the `(@v1.10)` in the REPL prompt.
105+
This lets us know that `v1.10` is the **active environment**.
106106
Different environments can have totally different packages and versions installed from another environment.
107107
The active environment is the environment that will be modified by Pkg commands such as `add`, `rm` and `update`.
108108

docs/src/glossary.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ may optionally have a manifest file:
1414
- **Manifest file:** a file in the root directory of a project, named
1515
`Manifest.toml` (or `JuliaManifest.toml`), describing a complete dependency graph
1616
and exact versions of each package and library used by a project. The file name may
17-
also be suffixed by `-v{major}.{minor}.toml` which julia will prefer if the version
18-
matches `VERSION`, allowing multiple environments to be maintained for different julia
17+
also be suffixed by `-v{major}.{minor}.toml` which Julia will prefer if the version
18+
matches `VERSION`, allowing multiple environments to be maintained for different Julia
1919
versions.
2020

2121
**Package:** a project which provides reusable functionality that can be used by

docs/src/managing-packages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Precompiling environment...
2828
2 dependencies successfully precompiled in 2 seconds
2929
```
3030

31-
Here we added the package `JSON` to the current environment (which is the default `@v1.8` environment).
31+
Here we added the package `JSON` to the current environment (which is the default `@v1.10` environment).
3232
In this example, we are using a fresh Julia installation,
3333
and this is our first time adding a package using Pkg. By default, Pkg installs the General registry
3434
and uses this registry to look up packages requested for inclusion in the current environment.

docs/src/toml-files.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ are described below.
2424

2525
For a package, the optional `authors` field is a TOML array describing the package authors.
2626
Entries in the array can either be a string in the form `"NAME"` or `"NAME <EMAIL>"`, or a table keys following the [Citation File Format schema](https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md) for either a
27-
[`person`](https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md#definitionsperson) or an[`entity`](https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md#definitionsentity).
27+
[`person`](https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md#definitionsperson) or an [`entity`](https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md#definitionsentity).
2828

2929
For example:
3030
```toml
@@ -130,7 +130,7 @@ handled by Pkg operations such as `add`.
130130

131131
### The `[sources]` section
132132

133-
Specifiying a path or repo (+ branch) for a dependency is done in the `[sources]` section.
133+
Specifying a path or repo (+ branch) for a dependency is done in the `[sources]` section.
134134
These are especially useful for controlling unregistered dependencies without having to bundle a
135135
corresponding manifest file.
136136

0 commit comments

Comments
 (0)