Skip to content

docs: improve grammar and formatting in world visualization documentation#69

Merged
ShisatoYano merged 1 commit intoShisatoYano:mainfrom
MikeDegany:fix-docs-issue-67
Mar 22, 2026
Merged

docs: improve grammar and formatting in world visualization documentation#69
ShisatoYano merged 1 commit intoShisatoYano:mainfrom
MikeDegany:fix-docs-issue-67

Conversation

@MikeDegany
Copy link
Contributor

Summary

This PR improves the English grammar, wording, and formatting in the world visualization documentation to address issue #67.

Changes Made

  • Grammar corrections: Fixed subject-verb agreement, article usage, and prepositions
  • Informal language: Replaced "gonna" with "going to" throughout
  • Consistency: Changed "as follow" to "as follows" (correct idiomatic expression)
  • Code formatting: Applied inline code formatting (backticks) to all code references including:
    • Variable names: x_lim, y_lim, objects, gif_name, show_plot, show_zoom, time_params
    • Method names: __init__, add_object(), not_show_plot(), update, draw
    • Class names: MinMax, TimeParameters
    • Module names: matplotlib.pyplot, animation
    • Directory paths: src/components/visualization
  • Clarity improvements: Rephrased awkward sentences for better readability

Review Checklist

  • Grammar and spelling corrected
  • Code references properly formatted
  • Content accuracy maintained
  • Follows documentation style guidelines

Fixes #67

…mentation

- Fix informal language
- Correct grammar errors
- Format code references (variables, methods, classes) with backticks
- Improve sentence structure and clarity for better readability

Fixes ShisatoYano#67
Copy link
Owner

@ShisatoYano ShisatoYano left a comment

Choose a reason for hiding this comment

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

@MikeDegany Thank you for reviewing and improving this document!It is very good for me to improve my English expression!! I reviewed and merged your PR.

@ShisatoYano ShisatoYano added the documentation Improvements or additions to documentation label Mar 22, 2026
@ShisatoYano ShisatoYano merged commit 04e3f28 into ShisatoYano:main Mar 22, 2026
3 checks passed
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation: Review contents and English expression for doc/1_world_visualization

2 participants