Skip to content

Commit 5951c99

Browse files
committed
Fix typos in docstrings
1 parent 929daa7 commit 5951c99

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

src/ChargeDensities/CylindricalChargeDensity.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ An example definition of a cylindrical charge density looks like this:
1818
```yaml
1919
charge_density:
2020
name: cylindrical
21-
r: # impurity profile with linear gradient in r
21+
r: # charge density with linear gradient in r
2222
init: 1.0e-10 # C/m³
2323
gradient: 1.0e-11 # C/m⁴
2424
```

src/ChargeDensities/LinearChargeDensity.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ that can each contain `init` for initial values at 0 and `gradient` for gradient
1616
An example definition of a linear charge density looks like this:
1717
```yaml
1818
charge_density:
19-
name: cylindrical
20-
x: # impurity profile with linear gradient in x
19+
name: linear
20+
x: # charge density with linear gradient in x
2121
init: 1.0e-10 # C/m³
2222
gradient: 1.0e-11 # C/m⁴
2323
```

src/ImpurityDensities/LinearImpurityDensity.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ that can each contain `init` for initial values at 0 and `gradient` for gradient
1616
An example definition of a linear impurity density looks like this:
1717
```yaml
1818
impurity_density:
19-
name: cylindrical
19+
name: linear
2020
x: # impurity profile with linear gradient in x
2121
init: 1.0e10 # 1/m³
2222
gradient: 1.0e11 # 1/m⁴
@@ -58,4 +58,4 @@ end
5858

5959
(*)(scale::Real, lcdm::LinearImpurityDensity{T}) where {T} = LinearImpurityDensity{T}(T.(scale .* lcdm.offsets), T.(scale .* lcdm.gradients))
6060

61-
(+)(offset::Union{<:Real, <:Quantity{<:Real, Unitful.𝐋^(-3)}}, lcdm::LinearImpurityDensity{T}) where {T} = LinearImpurityDensity{T}(T.(to_internal_units(offset) .+ lcdm.offsets), lcdm.gradients)
61+
(+)(offset::Union{<:Real, <:Quantity{<:Real, Unitful.𝐋^(-3)}}, lcdm::LinearImpurityDensity{T}) where {T} = LinearImpurityDensity{T}(T.(to_internal_units(offset) .+ lcdm.offsets), lcdm.gradients)

0 commit comments

Comments
 (0)