aesara-devs / aesara

Aesara is a Python library for defining, optimizing, and efficiently evaluating mathematical expressions involving multi-dimensional arrays.
https://aesara.readthedocs.io
Other
1.18k stars 153 forks source link

Add mention of tags and ARM environments to developer start guide #1465

Closed PaulScemama closed 1 year ago

PaulScemama commented 1 year ago

Resolves 1457

Very minimal change to the documentation for developer install guide. It

  1. adds instruction to collect tags.
  2. notes a possible error when using git:// and gives instruction to resolve if the issue occurs.
  3. notes using environment-arm.yml when creating conda environment if using ARM processor.

Here are a few important guidelines and requirements to check before your PR can be merged:

Not sure how to write a test for this, or if that is even necessary. Let me know!

PaulScemama commented 1 year ago

I had trouble building the documentation myself, but I just used docutils to convert .rst to .html and then rendered the html to get an idea of what the changes looked like (since the changes were so small). However, I wouldn't think my local developer (and documentation) environment being troublesome would have an effect on these tests?

brandonwillard commented 1 year ago

I had trouble building the documentation myself, but I just used docutils to convert .rst to .html and then rendered the html to get an idea of what the changes looked like (since the changes were so small). However, I wouldn't think my local developer (and documentation) environment being troublesome would have an effect on these tests?

Sorry, there were unrelated docs and test issues that have just been resolved.

PaulScemama commented 1 year ago

Ready for review @brandonwillard @rlouf. No rush!