Repository navigation
docs: improve grammar, clarity, and formatting in README.md - #497
Open
ishikajain-234 wants to merge 1 commit into
Open
ishikajain-234 wants to merge 1 commit into
ishikajain-234 wants to merge 1 commit into
Conversation
❌ Deploy Preview for stupendous-kringle-a86e81 failed.
|
Author
|
"Hi! This looks like it's waiting on workflow approval — happy to make any changes if needed. Thanks!" |
Fix run-on sentence and comma splice in introduction. Correct phrasing and capitalization in contribution sections. Standardize capitalization for CONTRIBUTING.md link and headers. Fixes numfocus#462
ishikajain-234
force-pushed
the
fix-readme-grammar-462
branch
from
September 24, 2026 03:54
49e50c4 to
fb4385d
Compare
This branch has not been deployed
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 of Changes
This PR addresses the minor grammatical errors, run-on sentences, and formatting inconsistencies in
README.mdas outlined in #462:DISCOVER-Cookbook."After that issue is made we feel free to open a pull request"to"After that issue is created, feel free to open a pull request".### Bug fixesto### Bug Fixes.[CONTRIBUTING.md](CONTRIBUTING.md).These documentation-only changes improve readability and polish without altering any technical requirements or contribution policies.
Related Issue
Fixes #462
Type of Change
Additional Notes (Optional)
Documentation-only changes confined to the upper sections of root
README.md. Verified GitHub-flavored markdown formatting and links.Checklist
README.md, which is rendered directly by GitHub rather than Sphinx/Jupyter Book)