[JOSS Review] Software / documentation
AnnikaStein opened this issue · 4 comments
- Syntax error in the last line of https://thraraujo.github.io/pysymmpol/getting-started.html#homogeneous-and-elementary-polynomials
- https://thraraujo.github.io/pysymmpol/pysymmpol.html#module-pysymmpol Module contents is empty, do you need this heading then?
tbc, as the review progresses:
Hi @AnnikaStein, I've fixed a couple of typos in the documentation, and also corrected what you suggested here.
I've also addressed some items from your checklist:
-
I expanded upon the statement of need and compared our software with SageMath, as it's currently the only known alternative for similar functionalities. While I've added pertinent details, I've kept the text concise to adhere to the +/- 500-word limit as requested. I've included a reference to SageMath.
-
I've made slight adjustments to the contributing document, although I found that the automatic document covers the necessary information effectively. This updated version is in the dev branch.
Hi @AnnikaStein, one last thing.
While I acknowledge the suggestion to test the software in other environments, I believe it might be overly cautious given the package's minimal dependencies. It's worth noting that the dependencies are not brand new releases.
Dear @AnnikaStein, today I've checked the dependencies. It turns out that they work for Python 3.11 and Sympy 1.11. I have not checked earlier versions. Numpy below 1.26.2 does not run. I have updated the README file and the documentation. They are in the main branch.
Very nice, thank you for working on these! Feel free to close this issue.