Skip to content

Fix Spelling and Punctuation Errors in Beam and Beam3D Docstrings and addition of Author name to .mailmap#28000

Merged
moorepants merged 6 commits into
sympy:masterfrom
saiudayagiri:add-name-to-mailmap
Apr 27, 2025
Merged

Fix Spelling and Punctuation Errors in Beam and Beam3D Docstrings and addition of Author name to .mailmap#28000
moorepants merged 6 commits into
sympy:masterfrom
saiudayagiri:add-name-to-mailmap

Conversation

@saiudayagiri
Copy link
Copy Markdown

@saiudayagiri saiudayagiri commented Apr 26, 2025 •
edited
Loading

Fix Spelling and Punctuation Errors in Beam and Beam3D Docstrings

References to other Issues or PRs

None

Brief description of what is fixed or changed

This PR corrects spelling and punctuation errors in the docstrings of the Beam and Beam3D classes in sympy/physics/continuum_mechanics/beam.py. The changes improve clarity and consistency without altering functionality. Key fixes include:

  • Removed repeated words (e.g., "is is" to "is", "it it" to "it is").
  • Corrected grammatical errors (e.g., "both of its end" to "both ends").
  • Standardized terminology (e.g., "X axis" to "X-axis").
  • Updated unit notation (e.g., kN/m/m to kN/m**2).
  • Added missing punctuation (e.g., commas, periods) for proper formatting.

The diff shows 13 additions and 13 deletions, all limited to docstrings.

Other comments

  • Ran pytest to confirm no functional changes.

Release Notes

NO ENTRY

@sympy-bot
Copy link
Copy Markdown

sympy-bot commented Apr 26, 2025 •
edited
Loading

✅

Hi, I am the SymPy bot. I'm here to help you write a release notes entry. Please read the guide on how to write release notes.

  • No release notes entry will be added for this pull request.
Click here to see the pull request description that was parsed. 
#### Fix Spelling and Punctuation Errors in Beam and Beam3D Docstrings

#### References to other Issues or PRs
None

#### Brief description of what is fixed or changed
This PR corrects spelling and punctuation errors in the docstrings of the `Beam` and `Beam3D` classes in `sympy/physics/continuum_mechanics/beam.py`. The changes improve clarity and consistency without altering functionality. Key fixes include:
- Removed repeated words (e.g., "is is" to "is", "it it" to "it is").
- Corrected grammatical errors (e.g., "both of its end" to "both ends").
- Standardized terminology (e.g., "X axis" to "X-axis").
- Updated unit notation (e.g.,  `kN/m/m` to `kN/m**2`).
- Added missing punctuation (e.g., commas, periods) for proper formatting.

The diff shows 13 additions and 13 deletions, all limited to docstrings.

#### Other comments
- Ran `pytest` to confirm no functional changes.

#### Release Notes
<!-- BEGIN RELEASE NOTES -->
NO ENTRY
<!-- END RELEASE NOTES -->

@moorepants
Copy link
Copy Markdown
Member

moorepants commented Apr 27, 2025 

Run bin/mailmap_check.py
This author is not included in the .mailmap file:
Sai Udayagiri <saibabu.udayagiri@email.com>
This author is not included in the .mailmap file:
saiudayagiri <144413200+saiudayagiri@users.noreply.github.com>

The .mailmap file needs to be updated because there are commits with
unrecognised author/email metadata.

        For instructions on updating the .mailmap file see:
https://docs.sympy.org/dev/contributing/new-contributors-guide/workflow-process.html#mailmap-instructions

The following authors will be added to the AUTHORS file at the time of
the next SymPy release.

	Pasquale Cocchini <pasquale.cocchini@gmail.com>
	Sai Udayagiri <saibabu.udayagiri@email.com>
	saiudayagiri <144413200+saiudayagiri@users.noreply.github.com>
Error: Process completed with exit code 1.

@saiudayagiri
Copy link
Copy Markdown
Author

saiudayagiri commented Apr 27, 2025

Dear Jason, I have updated the .mailmap file to include both my personal email and the GitHub no-reply email. Now all tests are passing. Please let me know if any further changes are needed.

oscarbenjamin
oscarbenjamin reviewed Apr 27, 2025
View reviewed changes
Comment thread .mailmap Outdated
moorepants
moorepants reviewed Apr 27, 2025
View reviewed changes
Comment thread .mailmap Outdated
@moorepants moorepants merged commit fe935ce into sympy:master Apr 27, 2025
45 checks passed
@moorepants moorepants mentioned this pull request Apr 27, 2025
Closed
@saiudayagiri saiudayagiri deleted the add-name-to-mailmap branch June 27, 2025 13:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@moorepants moorepants moorepants left review comments

@oscarbenjamin oscarbenjamin oscarbenjamin left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@saiudayagiri @sympy-bot @moorepants @oscarbenjamin