Skip to content

Fix README.md typos, grammar, and structural inconsistencies#9

Draft
Copilot wants to merge 2 commits intomainfrom
copilot/update-readme-docs
Draft

Fix README.md typos, grammar, and structural inconsistencies#9
Copilot wants to merge 2 commits intomainfrom
copilot/update-readme-docs

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Feb 28, 2026

README.md contained several typos, grammar errors, and structural inconsistencies that reduced clarity and professionalism.

Corrections

  • HTML: secsetsrcset in <source> tag
  • Grammar/wording:
    • "QSOsin" → "QSOs in" (missing space)
    • "is not support" → "does not support"
    • "is available" → "are available" (subject-verb agreement)
    • Removed misplaced "Unfortunately" from uninstall instructions
    • "prioritised on Github" → "prioritized on GitHub"
  • Code example: print(df)print(df_adi) (wrong variable name)
  • Structure: Returns: was incorrectly nested under Parameter: in four method entries (to_adi, to_pickle, read_pickle, to_excel); moved to correct sibling level
  • Consistency: "Licence" → "License" to match the badge; missing blank lines added after ## Getting Started and before ## FAQ / Troubleshooting
  • read_pickle return description: Added missing article "the" and removed trailing whitespace

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: JS2IIU-MH <146515386+JS2IIU-MH@users.noreply.github.com>
Copilot AI changed the title [WIP] Improve clarity and detail in README.md Fix README.md typos, grammar, and structural inconsistencies Feb 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants