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 small typo & clarify some grammar in the docs #279

Merged
merged 1 commit into from
Jan 4, 2024

Conversation

stevenharman
Copy link
Contributor

These are just some small language/grammar tweaks that tripped me up while reading through the README.

@fxn
Copy link
Owner

fxn commented Jan 4, 2024

Hey, thanks for proposing this. All good except for two:

That's a technique used to enable descending into subdirectories on demand

vs the original

That's a technique used to be able to descend into subdirectories on demand

This is not something you enable/disable wih a toggler, the technique makes lazy descents possible. I am not a native speaker, but "being able to" seems to capture the meaning better to me.

The other one is the addition of the article in

Zeitwerk ignores automatically any file or directory whose name starts with a dot, and any files that do not have an extension ".rb".

The file name "foo.rb" has extension ".rb", not an extension ".rb".

@stevenharman
Copy link
Contributor Author

👋 Hello @fxn, and thank you for the fast feedback! I've force-pushed some further tweaks based on what you said. I think these feel a bit more natural to a native speaker, while also capturing your intent. Happy to also drop these entirely, if you'd prefer.

Thank you, again, for all that you've put into Zeitwerk (and the community at large). ❤️

@fxn
Copy link
Owner

fxn commented Jan 4, 2024

@stevenharman awesome, that revision reads perfect. Thanks a lot for taking the time to edit this, idiomatic English is something I value and cannot produce myself. ❤️

@fxn fxn merged commit a7201b3 into fxn:main Jan 4, 2024
24 checks passed
@stevenharman stevenharman deleted the typo_and_doc_tweeks branch January 4, 2024 15:10
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.

None yet

2 participants