Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✏️ Fix a few typos in the source and documentation #1028

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

kkirsche
Copy link

This merge request fixes typos in various locations in the application.

@svlandeg svlandeg added the docs Improvements or additions to documentation label Oct 24, 2024
@svlandeg svlandeg changed the title Fix a few typos ✏️ Fix a few typos in the source and documentation Oct 24, 2024
Copy link
Member

@svlandeg svlandeg left a comment

Choose a reason for hiding this comment

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

Hi, thanks for the contribution! We appreciate it.

The typo fixes in the documentation and source comments like fine. 👍

However, I would refrain from changing convertor to converter as this is used as an argument in various public functions in main.py, and it would break people's code who call these functions with convertor=x. And while convertor is probably less frequently used than converter, I still think it's a valid term, so as such I would just keep that one across all occurrences. Can you make that edit? Thanks! 🙏

@svlandeg svlandeg marked this pull request as draft October 25, 2024 10:07
Copy link
Member

@svlandeg svlandeg left a comment

Choose a reason for hiding this comment

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

I've gone ahead and reverted the convertor changes, to avoid unnecessary breaking changes. This PR should now be good to merge 🎉

@svlandeg svlandeg marked this pull request as ready for review November 8, 2024 09:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants