Skip to content

Commit

Permalink
Fix doc string length
Browse files Browse the repository at this point in the history
the first sentence of doc should not be larger than 80
  • Loading branch information
singularitti committed Jun 15, 2021
1 parent a3162fe commit 93803ad
Showing 1 changed file with 56 additions and 47 deletions.
103 changes: 56 additions & 47 deletions src/QuantumESPRESSOCommands.jl
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ Create configurations for `pw.x`.
# Arguments
- `exe::String="pw.x"`: the path to the executable.
- `chdir::Bool=true`: whether to change directory to where the input file is stored when
running `pw.x`. If `false`, stay in the current directory.
- `options::ParallelizationFlags=ParallelizationFlags()`: the parallelization flags of
`pw.x`.
- `chdir::Bool=true`: whether to change directory to where the input file is
stored when running `pw.x`. If `false`, stay in the current directory.
- `options::ParallelizationFlags=ParallelizationFlags()`: the parallelization
flags of `pw.x`.
"""
@option struct PwxConfig <: CommandConfig
exe::String = "pw.x"
Expand All @@ -45,10 +45,10 @@ Create configurations for `ph.x`.
# Arguments
- `exe::String="ph.x"`: the path to the executable.
- `chdir::Bool=true`: whether to change directory to where the input file is stored when
running `ph.x`. If `false`, stay in the current directory.
- `options::ParallelizationFlags=ParallelizationFlags()`: the parallelization flags of
`ph.x`.
- `chdir::Bool=true`: whether to change directory to where the input file is
stored when running `ph.x`. If `false`, stay in the current directory.
- `options::ParallelizationFlags=ParallelizationFlags()`: the parallelization
flags of `ph.x`.
"""
@option struct PhxConfig <: CommandConfig
exe::String = "ph.x"
Expand All @@ -62,10 +62,10 @@ Create configurations for `q2r.x`.
# Arguments
- `exe::String="q2r.x"`: the path to the executable.
- `chdir::Bool=true`: whether to change directory to where the input file is stored when
running `q2r.x`. If `false`, stay in the current directory.
- `options::ParallelizationFlags=ParallelizationFlags()`: the parallelization flags of
`q2r.x`.
- `chdir::Bool=true`: whether to change directory to where the input file is
stored when running `q2r.x`. If `false`, stay in the current directory.
- `options::ParallelizationFlags=ParallelizationFlags()`: the parallelization
flags of `q2r.x`.
"""
@option struct Q2rxConfig <: CommandConfig
exe::String = "q2r.x"
Expand All @@ -79,10 +79,10 @@ Create configurations for `matdyn.x`.
# Arguments
- `exe::String="matdyn.x"`: the path to the executable.
- `chdir::Bool=true`: whether to change directory to where the input file is stored when
running `matdyn.x`. If `false`, stay in the current directory.
- `options::ParallelizationFlags=ParallelizationFlags()`: the parallelization flags of
`matdyn.x`.
- `chdir::Bool=true`: whether to change directory to where the input file is
stored when running `matdyn.x`. If `false`, stay in the current directory.
- `options::ParallelizationFlags=ParallelizationFlags()`: the parallelization
flags of `matdyn.x`.
"""
@option struct MatdynxConfig <: CommandConfig
exe::String = "matdyn.x"
Expand All @@ -96,10 +96,10 @@ Create configurations for `dynmat.x`.
# Arguments
- `exe::String="dynmat.x"`: the path to the executable.
- `chdir::Bool=true`: whether to change directory to where the input file is stored when
running `dynmat.x`. If `false`, stay in the current directory.
- `options::ParallelizationFlags=ParallelizationFlags()`: the parallelization flags of
`dynmat.x`.
- `chdir::Bool=true`: whether to change directory to where the input file is
stored when running `dynmat.x`. If `false`, stay in the current directory.
- `options::ParallelizationFlags=ParallelizationFlags()`: the parallelization
flags of `dynmat.x`.
"""
@option struct DynmatxConfig <: CommandConfig
exe::String = "dynmat.x"
Expand All @@ -124,11 +124,13 @@ Run command `pw.x`.
# Arguments
- `input`: the path to the input file.
- `output=mktemp(parentdir(input))[1]`: the path to the output file.
- `error=output`: the path to the error file. By default, it logs into the output file.
- `use_script=false`: if `true`, generate a shell script (with a random name) under the
directory where the input file is stored, and run it.
- `error=output`: the path to the error file. By default, it logs into the
output file.
- `use_script=false`: if `true`, generate a shell script (with a random name)
under the directory where the input file is stored, and run it.
- `mpi=MpiexecConfig()`: MPI configurations.
- `main=PwxConfig()`: the configurations of the main executable. In this case, `pw.x`.
- `main=PwxConfig()`: the configurations of the main executable. In this case,
`pw.x`.
- `cfgfile=""`: if not empty, load these configurations from a file.
"""
@cast function pw(
Expand Down Expand Up @@ -163,11 +165,13 @@ Run command `ph.x`.
# Arguments
- `input`: the path to the input file.
- `output=mktemp(parentdir(input))[1]`: the path to the output file.
- `error=output`: the path to the error file. By default, it logs into the output file.
- `use_script=false`: if `true`, generate a shell script (with a random name) under the
directory where the input file is stored, and run it.
- `error=output`: the path to the error file. By default, it logs into the
output file.
- `use_script=false`: if `true`, generate a shell script (with a random name)
under the directory where the input file is stored, and run it.
- `mpi=MpiexecConfig()`: MPI configurations.
- `main=PhxConfig()`: the configurations of the main executable. In this case, `ph.x`.
- `main=PhxConfig()`: the configurations of the main executable. In this case,
`ph.x`.
- `cfgfile=""`: if not empty, load these configurations from a file.
"""
@cast function ph(
Expand Down Expand Up @@ -202,11 +206,13 @@ Run command `q2r.x`.
# Arguments
- `input`: the path to the input file.
- `output=mktemp(parentdir(input))[1]`: the path to the output file.
- `error=output`: the path to the error file. By default, it logs into the output file.
- `use_script=false`: if `true`, generate a shell script (with a random name) under the
directory where the input file is stored, and run it.
- `error=output`: the path to the error file. By default, it logs into the
output file.
- `use_script=false`: if `true`, generate a shell script (with a random name)
under the directory where the input file is stored, and run it.
- `mpi=MpiexecConfig()`: MPI configurations.
- `main=Q2rxConfig()`: the configurations of the main executable. In this case, `q2r.x`.
- `main=Q2rxConfig()`: the configurations of the main executable. In this case,
`q2r.x`.
- `cfgfile=""`: if not empty, load these configurations from a file.
"""
@cast function q2r(
Expand Down Expand Up @@ -241,12 +247,13 @@ Run command `matdyn.x`.
# Arguments
- `input`: the path to the input file.
- `output=mktemp(parentdir(input))[1]`: the path to the output file.
- `error=output`: the path to the error file. By default, it logs into the output file.
- `use_script=false`: if `true`, generate a shell script (with a random name) under the
directory where the input file is stored, and run it.
- `error=output`: the path to the error file. By default, it logs into the
output file.
- `use_script=false`: if `true`, generate a shell script (with a random name)
under the directory where the input file is stored, and run it.
- `mpi=MpiexecConfig()`: MPI configurations.
- `main=MatdynxConfig()`: the configurations of the main executable. In this case,
`matdyn.x`.
- `main=MatdynxConfig()`: the configurations of the main executable. In this
case, `matdyn.x`.
- `cfgfile=""`: if not empty, load these configurations from a file.
"""
@cast function matdyn(
Expand Down Expand Up @@ -281,12 +288,13 @@ Run command `dynmat.x`.
# Arguments
- `input`: the path to the input file.
- `output=mktemp(parentdir(input))[1]`: the path to the output file.
- `error=output`: the path to the error file. By default, it logs into the output file.
- `use_script=false`: if `true`, generate a shell script (with a random name) under the
directory where the input file is stored, and run it.
- `error=output`: the path to the error file. By default, it logs into the
output file.
- `use_script=false`: if `true`, generate a shell script (with a random name)
under the directory where the input file is stored, and run it.
- `mpi=MpiexecConfig()`: MPI configurations.
- `main=DynmatxConfig()`: the configurations of the main executable. In this case,
`dynmat.x`.
- `main=DynmatxConfig()`: the configurations of the main executable. In this
case, `dynmat.x`.
- `cfgfile=""`: if not empty, load these configurations from a file.
"""
@cast function dynmat(
Expand Down Expand Up @@ -338,11 +346,12 @@ Make commands for QuantumESPRESSO executables.
# Arguments
- `input`: the path to the input file.
- `output=mktemp(parentdir(input))[1]`: the path to the output file.
- `error=output`: the path to the error file. By default, it logs into the output file.
- `dir=parentdir(input)`: change the working directory to `dir`. By default, it is the
directory where the input file is stored.
- `use_script=false`: if `true`, generate a shell script (with a random name) under `dir`
and run it.
- `error=output`: the path to the error file. By default, it logs into the
output file.
- `dir=parentdir(input)`: change the working directory to `dir`. By default, it
is the directory where the input file is stored.
- `use_script=false`: if `true`, generate a shell script (with a random name)
under `dir` and run it.
- `mpi=MpiexecConfig()`: MPI configurations.
- `main`: the configurations of the main executable.
"""
Expand Down

0 comments on commit 93803ad

Please sign in to comment.