Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
xivh committed Aug 1, 2024
1 parent df4af63 commit cfea98c
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions python/src/composition.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -487,7 +487,7 @@ PYBIND11_MODULE(_composition, m) {
.def("independent_compositions",
&composition::CompositionConverter::independent_compositions,
R"pbdoc(
The dimensionality of the composition space, :math:`k`.
The dimensionality of the composition space, :math:`k`. This is the number of parametric composition axes.
)pbdoc")
.def("axes", &composition::CompositionConverter::axes,
R"pbdoc(
Expand Down Expand Up @@ -559,18 +559,18 @@ PYBIND11_MODULE(_composition, m) {
.def("param_component_formula",
&composition::CompositionConverter::comp_formula, py::arg("i"),
R"pbdoc(
Return formula the i-th parametric composition component, :math:`x_i`, in terms of :math:`\vec{n}`.
Return formula for the i-th parametric composition component, :math:`x_i`, in terms of :math:`\vec{n}`.
)pbdoc")
.def("mol_component_formula",
&composition::CompositionConverter::comp_n_formula, py::arg("i"),
R"pbdoc(
Return formula the i-th mol composition component, :math:`n_i`, in terms of :math:`\vec{x}`.
Return formula for the i-th mol composition component, :math:`n_i`, in terms of :math:`\vec{x}`.
)pbdoc")
.def("param_chem_pot_formula",
&composition::CompositionConverter::param_chem_pot_formula,
py::arg("i"),
R"pbdoc(
Return formula the parametric composition conjugate potential in terms of the chemical potentials.
Return formula for the parametric composition conjugate potential in terms of the chemical potentials.
)pbdoc");

m.def("make_composition_space", &composition::composition_space,
Expand Down

0 comments on commit cfea98c

Please sign in to comment.