search

AdvancedPhotonSource / xdesign

Tools for designing x-ray phantoms and experiments.
https://xdesign.readthedocs.io
Other
24 stars 16 forks source link

New geometry class and some minor fixes #78

Closed bwohlberg closed 2 years ago

bwohlberg commented 2 years ago

Note: the API docs for RegularPolygon.__init__ are specified in a way that is not consistent with the rest of the package because I could not see a consistent way to include them.

pep8speaks commented 2 years ago

Hello @bwohlberg! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

Line 552:36: W605 invalid escape sequence '\p' Line 553:13: W605 invalid escape sequence '\p'

Comment last updated at 2022-01-11 23:44:36 UTC
carterbox commented 2 years ago

Thanks for opening a PR, I have seen it, and I will take a look when I have time.

bwohlberg commented 2 years ago

I have not done any testing to confirm, but I expect that 31eb3cf will resolve #77.

bwohlberg commented 2 years ago

Please add some text to the docs for RegularPolygon about the default orientation. i.e. Something about how one vertex is always located at (center + radius, center) unless that angle parameter is used.

Added. I was unable to check whether the text is formatted properly because the sphinx configuration doesn't actually generate the docs for __init__.

I also added a setting for bibtex_bibfiles sphinx conf.py in an attempt to address the failure of the readthedocs build workflow.

carterbox commented 2 years ago

I also added a setting for bibtex_bibfiles sphinx conf.py in an attempt to address the failure of the readthedocs build workflow.

Yes, I'm trying to fix this problem in #81. I tried to setup readthedocs to validate pull requests, but the docs it generates fail with some SSL certificate error for me. https://xdesign--78.org.readthedocs.build/en/78/

bwohlberg commented 2 years ago

Yes, I'm trying to fix this problem in #81. I tried to setup readthedocs to validate pull requests, but the docs it generates fail with some SSL certificate error for me. https://xdesign--78.org.readthedocs.build/en/78/

I can access that URL without any issues. (Assuming I'm understanding the problem correctly.)

carterbox commented 2 years ago

OK, then it's being blocked by Argonne's cybersecurity policy, so I can't see it from my work station. Please look to see if the docstring is formatted how you like it.

bwohlberg commented 2 years ago

It looks good to me.

carterbox commented 2 years ago

Thanks for your contribution! 🔥