Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
Mar 9, 2023

Conversation

PaulScemama
Copy link

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:

  • There is an informative high-level description of the changes.
  • The description and/or commit message(s) references the relevant GitHub issue(s).
  • pre-commit is installed and set up.
  • The commit messages follow these guidelines.
  • The commits correspond to relevant logical changes, and there are no commits that fix changes introduced by other commits in the same branch/BR.
  • [] There are tests covering the changes introduced in the PR.

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

@PaulScemama
Copy link
Author

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
Copy link
Member

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.

@brandonwillard brandonwillard added the documentation Improvements or additions to documentation label Mar 8, 2023
@PaulScemama PaulScemama changed the title Draft: Resolve: "Mention the need to pull tags when performing a development install" + ARM processor install. Resolve: "Mention the need to pull tags when performing a development install" + ARM processor install. Mar 8, 2023
@PaulScemama
Copy link
Author

Ready for review @brandonwillard @rlouf. No rush!

@brandonwillard brandonwillard added the enhancement New feature or request label Mar 9, 2023
@brandonwillard brandonwillard changed the title Resolve: "Mention the need to pull tags when performing a development install" + ARM processor install. Add mention of tags and ARM environments to developer start guide Mar 9, 2023
Copy link
Member

@brandonwillard brandonwillard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great; thanks!

@brandonwillard brandonwillard merged commit 83ce997 into aesara-devs:main Mar 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Mention the need to pull tags when performing a development install
3 participants