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

📝[Docs]: Typo in README.md #353

Closed
4 tasks done
Rajendran2201 opened this issue Jun 18, 2024 · 2 comments · Fixed by #362
Closed
4 tasks done

📝[Docs]: Typo in README.md #353

Rajendran2201 opened this issue Jun 18, 2024 · 2 comments · Fixed by #362
Assignees
Labels
enhancement New feature or request gssoc

Comments

@Rajendran2201
Copy link
Contributor

Is there an existing issue for this?

  • I have searched the existing issues

Issue Description

There is a small typo in the description of Keras library in the README file.

Suggested Change

The sentence currently reads:
"That documentation is a great resource for anyone looking to get started with Keras, a popular deep learning framework. Keras provides a user-friendly interface for building and training deep learning models. Whether you're a beginner or an experienced practitioner, Keras offers a lot of flexibility and ease of use."

It should be:
"This documentation is a great resource for anyone looking to get started with Keras, a popular deep learning framework. Keras provides a user-friendly interface for building and training deep learning models. Whether you're a beginner or an experienced practitioner, Keras offers a lot of flexibility and ease of use."

Rationale

While "that documentation" is not technically incorrect, "this documentation" is likely a better fit for clarity and immediacy in the context of a README file.

Based on the usual context of a README file, "this documentation" is typically more appropriate because it refers to the documentation directly associated with the repository. It indicates that the documentation is the immediate subject of discussion. Therefore, suggesting a change from "that documentation" to "this documentation" is reasonable and can improve the readability and clarity of the text.

Urgency

Medium

Record

  • I have read the Contributing Guidelines
  • I'm a GSSOC'24 contributor
  • I want to work on this issue
@Rajendran2201 Rajendran2201 added the enhancement New feature or request label Jun 18, 2024
Copy link

Thank you for creating this issue! 🎉 We'll look into it as soon as possible. In the meantime, please make sure to provide all the necessary details and context. If you have any questions reach out to LinkedIn. Your contributions are highly appreciated! 😊

Note: This repo is for beginners to learn and start with Opensource we won't accept more than 10 issues from a single person, This restriction applies to Gssoc project which has a similar kind of adding folder files, Points will be reduced when we find Spam.

I Maintain the repo issue twice a day, or ideally 1 day, If your issue goes stale for more than one day you can tag and comment on this same issue.

You can also check our CONTRIBUTING.md for guidelines on contributing to this project.

Copy link

Hello @Rajendran2201! Your issue #353 has been closed. Thank you for your contribution!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request gssoc
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants