Skip to content

docs: enhance clarity and consistency in README by correcting platform capitalization #21493

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

Merged
merged 2 commits into from
Jul 24, 2025

Conversation

Gayathri-K-Binoy
Copy link
Contributor

This PR enhances the clarity and polish of the Keras README by correcting minor but important inconsistencies in platform naming:

  • Updated “python” to “Python” to reflect the proper name of the language.
  • Corrected “MacOS” to “macOS” to match Apple’s official styling.

While subtle, these adjustments contribute to a more professional, accurate, and trustworthy documentation experience for new developers evaluating or onboarding with Keras 3. Maintaining consistent terminology strengthens the credibility and quality of open source documentation.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Summary of Changes

Hello @Gayathri-K-Binoy, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on enhancing the clarity and professionalism of the Keras README by addressing minor but important inconsistencies in platform and language naming. The changes aim to improve the overall quality and trustworthiness of the documentation for new users.

Highlights

  • Documentation Consistency: Corrected the capitalization of 'MacOS' to 'macOS' in the README to align with Apple's official styling.
  • Documentation Consistency: Updated 'python' to 'Python' in the README to reflect the proper name of the language.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This PR makes good improvements to the documentation by correcting the capitalization of 'macOS' and 'Python' in the README. The changes enhance consistency and professionalism. I've added one comment suggesting a similar consistency fix for 'JAX' in the same section to further improve the document. Overall, this is a valuable documentation update.

@codecov-commenter
Copy link

codecov-commenter commented Jul 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.85%. Comparing base (df481e9) to head (a389f69).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master   #21493   +/-   ##
=======================================
  Coverage   82.84%   82.85%           
=======================================
  Files         565      565           
  Lines       55656    55694   +38     
  Branches     8685     8689    +4     
=======================================
+ Hits        46108    46144   +36     
- Misses       7433     7434    +1     
- Partials     2115     2116    +1     
Flag Coverage Δ
keras 82.66% <ø> (+<0.01%) ⬆️
keras-jax 63.35% <ø> (-0.05%) ⬇️
keras-numpy 58.55% <ø> (-0.04%) ⬇️
keras-openvino 34.00% <ø> (+0.04%) ⬆️
keras-tensorflow 63.83% <ø> (-0.05%) ⬇️
keras-torch 63.42% <ø> (-0.05%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@google-ml-butler google-ml-butler bot added kokoro:force-run ready to pull Ready to be merged into the codebase labels Jul 24, 2025
@fchollet fchollet merged commit 72a7b41 into keras-team:master Jul 24, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kokoro:force-run ready to pull Ready to be merged into the codebase size:XS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants