Adding basic install instructions#400
Merged
Merged
Conversation
Contributor
|
🧙 Sourcery has finished reviewing your pull request! Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
There was a problem hiding this comment.
Hey - I've found 2 issues
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path="docs/installation.rst" line_range="7" />
<code_context>
-The easiest way to install aiapy to follow the instructions on :ref:`sunpy-tutorial-installing`.
-The only difference is that you will need to install aiapy instead of sunpy.
+The easiest way to install aiapy to follow the instructions on :ref:`sunpy-tutorial-installing`. The only difference is that you will need to install aiapy instead of sunpy.
+
+If you are not using mini-conda:
</code_context>
<issue_to_address>
**issue (typo):** Add the missing verb "is" in the introductory sentence.
The sentence currently reads "The easiest way to install aiapy to follow the instructions...". To be grammatically correct, it should read "The easiest way to install aiapy is to follow the instructions...".
```suggestion
The easiest way to install aiapy is to follow the instructions on :ref:`sunpy-tutorial-installing`. The only difference is that you will need to install aiapy instead of sunpy.
```
</issue_to_address>
### Comment 2
<location path="docs/installation.rst" line_range="9" />
<code_context>
-The only difference is that you will need to install aiapy instead of sunpy.
+The easiest way to install aiapy to follow the instructions on :ref:`sunpy-tutorial-installing`. The only difference is that you will need to install aiapy instead of sunpy.
+
+If you are not using mini-conda:
+
+.. code-block:: bash
</code_context>
<issue_to_address>
**issue (typo):** Correct the product name "mini-conda" to "Miniconda".
Use the official spelling and capitalization (“Miniconda”) to match Conda’s documentation and avoid confusion.
```suggestion
If you are not using Miniconda:
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
hayesla
commented
Apr 28, 2026
nabobalis
approved these changes
Apr 28, 2026
Member
|
Thanks again @hayesla |
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
d20de9a to
869e3e7
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
fixes #399
Basically, this is just as several people asked my at a summer school how to install as it wasnt on the webpage and didnt read the sunpy docs properly
Summary by Sourcery
Documentation: