Docs : added guidance on what to do after the installation #864
Closed
omiingale-oi wants to merge 2 commits intopysal:mainfrom
Closed
Docs : added guidance on what to do after the installation #864omiingale-oi wants to merge 2 commits intopysal:mainfrom
omiingale-oi wants to merge 2 commits intopysal:mainfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #864 +/- ##
=======================================
+ Coverage 85.5% 85.5% +0.1%
=======================================
Files 151 152 +1
Lines 16092 16114 +22
=======================================
+ Hits 13758 13785 +27
+ Misses 2334 2329 -5
🚀 New features to boost your workflow:
|
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.
Description
Adds a short
Next stepssection toinstallation.rst. After installinglibpysal, new users have no clear guidance on where to go next in the documentation.The added text point users to the User Guide introduction, where they can see examples and understand the main parts of the library.
This improves the beginner experience without changing any functionallity.
Checklist
You have run tests on this submission locally using
pyteston your changes.N/A: This is a documentation only change (does not affect code/tests).
This pull request is directed to the
pysal/mainbranch.This pull introduces new functionality covered by docstrings and unittests.
N/A: No new functionality/code changes are introduced.
You have assigned a reviewer and added relevant labels.
N/A: No reviewer assigned, no labels added.
The justification for this PR is:
After installing
libpysal, new users are not given any guidance on what to read or try next. This PR adds a “Next steps” section to point them to the User Guide, making the documentation flow clean & clear for beginners.No AI tools were used in this contribution.