Closed yuxuanzhuang closed 5 months ago
This is part of the review process for https://github.com/openjournals/joss-reviews/issues/6295
Great work!! I've noticed a few minor issues that could be addressed:
In https://pyeql.readthedocs.io/en/latest/, s1 = pyEQL.Solution -> s1 = Solution().
s1 = Solution()
In https://pyeql.readthedocs.io/en/latest/chemistry.html#how-to-enter-valid-chemical-formulas:
Na2SO4
In https://pyeql.readthedocs.io/en/latest/mixing.html, there is an issue with an equation not being shown correctly.
In https://pyeql.readthedocs.io/en/latest/class_solution.html and https://pyeql.readthedocs.io/en/latest/internal.html have rendering problems
Return
see also
Thank you for reporting @yuxuanzhuang !
Reproducing here some additional comments from the JOSS review related to Docs cleanups:
List of some small things:
This is part of the review process for https://github.com/openjournals/joss-reviews/issues/6295
Great work!! I've noticed a few minor issues that could be addressed:
In https://pyeql.readthedocs.io/en/latest/, s1 = pyEQL.Solution ->
s1 = Solution()
.In https://pyeql.readthedocs.io/en/latest/chemistry.html#how-to-enter-valid-chemical-formulas:
Na2SO4
.In https://pyeql.readthedocs.io/en/latest/mixing.html, there is an issue with an equation not being shown correctly.
In https://pyeql.readthedocs.io/en/latest/class_solution.html and https://pyeql.readthedocs.io/en/latest/internal.html have rendering problems
Return
is displayed correctly.see also
sections are not functioning as expected.