Removed unnecessary name qualifications

brainandforce · Nov 30, 2023 · 90ec2ff · 90ec2ff
1 parent e91f014
commit 90ec2ff
Show file tree

Hide file tree

Showing 5 changed files with 113 additions and 112 deletions.
diff --git a/docs/src/api/atoms.md b/docs/src/api/atoms.md
@@ -2,30 +2,30 @@
 
 ## Constructors and types
 ```@docs
-Electrum.NamedAtom
-Electrum.AbstractAtomPosition
-Electrum.CartesianAtomPosition
-Electrum.FractionalAtomPosition
-Electrum.AbstractAtomList
-Electrum.AtomList
-Electrum.PeriodicAtomList
+NamedAtom
+AbstractAtomPosition
+CartesianAtomPosition
+FractionalAtomPosition
+AbstractAtomList
+AtomList
+PeriodicAtomList
 ```
 
 ## Extracting data
 ```@docs
-Electrum.name
-Electrum.atomic_number
-Electrum.isdummy
-Electrum.atomtypes
-Electrum.natomtypes
-Electrum.atomcounts
+name
+atomic_number
+isdummy
+atomtypes
+natomtypes
+atomcounts
 Base.isapprox(::T, ::T) where T<:AbstractAtomPosition
-Electrum.distance(::CartesianAtomPosition, ::CartesianAtomPosition)
+distance(::CartesianAtomPosition, ::CartesianAtomPosition)
 ```
 
 ## Moving and processing atom lists
 ```@docs
-Electrum.deduplicate
+deduplicate
 Electrum.move_into_cell
-Electrum.supercell
+supercell
 ```
diff --git a/docs/src/api/crystals.md b/docs/src/api/crystals.md
@@ -2,14 +2,14 @@
 
 ## Constructors and types
 ```@docs
-Electrum.AbstractCrystal
-Electrum.Crystal
-Electrum.CrystalWithDatasets
+AbstractCrystal
+Crystal
+CrystalWithDatasets
 ```
 
 ## Methods
 ```@docs
-Electrum.generators
-Electrum.get_transform
-Electrum.set_transform!
+generators
+get_transform
+set_transform!
 ```
diff --git a/docs/src/api/data.md b/docs/src/api/data.md
@@ -4,20 +4,20 @@
 
 ## Basic data grids
 ```@docs
-Electrum.DataGrid
-Electrum.RealDataGrid
-Electrum.ReciprocalDataGrid
-Electrum.fft
-Electrum.ifft
+DataGrid
+RealDataGrid
+ReciprocalDataGrid
+fft
+ifft
 AbstractFFTs.fftfreq(::DataGrid)
-Electrum.volume(::DataGrid)
-Electrum.voxelsize
-Electrum.integrate
-Electrum.partial_derivative
-Electrum.cell_gradient
-Electrum.gradient
+volume(::DataGrid)
+voxelsize
+integrate
+partial_derivative
+cell_gradient
+gradient
 Electrum.directional_derivative
-Electrum.remove_shift 
+remove_shift 
 ```
 
 ## FFT iterators
@@ -28,61 +28,61 @@ Electrum.FFTBins
 
 ## Spin states
 ```@docs
-Electrum.Multiplicity
-Electrum.SpinBivector
+Multiplicity
+SpinBivector
 ```
 
 ## Energies and occupancies
 ```@docs
-Electrum.AbstractEnergyData
-Electrum.EnergyOccupancy
-Electrum.StateDensity
-Electrum.EnergiesOccupancies
-Electrum.energy
-Electrum.occupancy
-Electrum.density
-Electrum.energies
-Electrum.occupancies
-Electrum.densities
-Electrum.min_energy
-Electrum.max_energy
-Electrum.min_occupancy
-Electrum.max_occupancy
-Electrum.fermi
+AbstractEnergyData
+EnergyOccupancy
+StateDensity
+EnergiesOccupancies
+energy
+occupancy
+density
+energies
+occupancies
+densities
+min_energy
+max_energy
+min_occupancy
+max_occupancy
+fermi
 ```
 
 ## Wavefunctions
 ```@docs
-Electrum.PlanewaveWavefunction
-Electrum.PlanewaveIndex
-Electrum.nspin
-Electrum.nband(::PlanewaveWavefunction)
-Electrum.nonzero_g_indices
-Electrum.nonzero_g_vectors
+PlanewaveWavefunction
+PlanewaveIndex
+nspin
+nband(::PlanewaveWavefunction)
+nonzero_g_indices
+nonzero_g_vectors
 ```
 
 ## Band structures
 ```@docs
-Electrum.BandAtKPoint
-Electrum.BandStructure
-Electrum.nband(::BandStructure)
-Electrum.nband(::BandAtKPoint)
-Electrum.FatBands
+BandAtKPoint
+BandStructure
+nband(::BandStructure)
+nband(::BandAtKPoint)
+FatBands
 ```
 
 ## Density of states
 ```@docs
-Electrum.AbstractDensityOfStates
-Electrum.DensityOfStates
-Electrum.ProjectedDensityOfStates
-Electrum.fermi(::AbstractDensityOfStates)
-Electrum.smear
-Electrum.energies(::AbstractDensityOfStates)
-Electrum.nelectrons
+AbstractDensityOfStates
+DensityOfStates
+ProjectedDensityOfStates
+fermi(::AbstractDensityOfStates)
+smear
+energies(::AbstractDensityOfStates)
+nelectrons
 ```
 
 ## Atomic data
 ```@docs
-Electrum.SphericalHarmonic
+SphericalHarmonic
 LinearAlgebra.dot(::SphericalHarmonic, ::SphericalHarmonic)
 ```
diff --git a/docs/src/api/filetypes.md b/docs/src/api/filetypes.md
@@ -4,71 +4,71 @@
 
 ### Reading
 ```@docs
-Electrum.readXYZ
-Electrum.readCPcoeff
-Electrum.readCPgeo
-Electrum.readCPcell
+readXYZ
+readCPcoeff
+readCPgeo
+readCPcell
 ```
 
 ### Writing
 ```@docs
-Electrum.writeXYZ
-Electrum.writeTOML
+writeXYZ
+writeTOML
 ```
 
 ## XCrysDen XSF files
 
 ### Reading
 ```@docs
-Electrum.readXSF
-Electrum.readXSF3D
+readXSF
+readXSF3D
 ```
 
 ### Writing
 ```@docs
-Electrum.writeXSF
+writeXSF
 ```
 
 ## ABINIT files
 
 ### Reading
 
 ```@docs
-Electrum.read_abinit_DEN
-Electrum.read_abinit_POT
-Electrum.read_abinit_WFK
+read_abinit_DEN
+read_abinit_POT
+read_abinit_WFK
 ```
 
 ## VASP files
 
 ### Reading
 
 ```@docs
-Electrum.readCONTCAR
-Electrum.readDOSCAR
-Electrum.readPOSCAR
-Electrum.readPROCAR
-Electrum.readWAVECAR
-Electrum.get_fermi
+readCONTCAR
+readDOSCAR
+readPOSCAR
+readPROCAR
+readWAVECAR
+get_fermi
 ```
 
 ### Writing
 
 ```@docs
-Electrum.writeCONTCAR
-Electrum.writePOSCAR
+writeCONTCAR
+writePOSCAR
 ```
 
 ## LAMMPS
 
 ### Reading
 
 ```@docs
-Electrum.read_lammps_data
+read_lammps_data
 ```
 
 ### Writing
 
 ```@docs
-Electrum.write_lammps_data
+write_lammps_data
 ```
diff --git a/docs/src/api/geometry.md b/docs/src/api/geometry.md
@@ -4,49 +4,50 @@
 
 ### Constructors and types
 ```@docs
-Electrum.RealBasis
-Electrum.ReciprocalBasis
-Electrum.AbstractBasis
+Electrum.LatticeBasis
+RealBasis
+ReciprocalBasis
+AbstractBasis
 ```
 
 ### Basis information from other data types
 ```@docs
-Electrum.basis
-Electrum.dualbasis
+basis
+dualbasis
 ```
 
 ### Mathematical operations
 ```@docs
 Base.inv(::Electrum.LatticeBasis)
-Electrum.dual
-Electrum.lengths(::Electrum.LatticeBasis)
-Electrum.volume(::Electrum.LatticeBasis)
-Electrum.angles_cos
-Electrum.angles_rad
-Electrum.angles_deg
-Electrum.gram
-Electrum.triangularize
+dual
+lengths(::Electrum.LatticeBasis)
+volume(::Electrum.LatticeBasis)
+angles_cos
+angles_rad
+angles_deg
+gram
+triangularize
 ```
 
 ### Iterators
 ```@docs
-Electrum.eachvertex
+eachvertex
 ```
 
 ### Miscellaneous
 ```@docs
-Electrum.maxHKLindex
+maxHKLindex
 ```
 
 ## Shift vectors
 ```@docs
-Electrum.ShiftVector
-Electrum.KPoint
-Electrum.weight
+ShiftVector
+KPoint
+weight
 ```
 
 ## k-point meshes
 ```@docs
-Electrum.KPointMesh
-Electrum.nkpt
+KPointMesh
+nkpt
 ```