Skip to content

Renaming#20

Merged
dbookstaber merged 22 commits intomasterfrom
renaming
Sep 15, 2025
Merged

Renaming#20
dbookstaber merged 22 commits intomasterfrom
renaming

Conversation

@dbookstaber
Copy link
Copy Markdown
Owner

Trying to rename py_ballisticcalc to pyballistic

Copy link
Copy Markdown

@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 @dbookstaber, 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 primarily focuses on a comprehensive renaming of the py_ballisticcalc package to pyballistic across the entire codebase, documentation, and project configuration. This change aims to simplify the package name and improve consistency. Additionally, the documentation has been significantly restructured and enhanced with new content and features like KaTeX rendering, and some outdated code examples have been removed.

Highlights

  • Package Renaming: The core py_ballisticcalc package and its py_ballisticcalc.exts extension have been comprehensively renamed to pyballistic and pyballistic.exts respectively. This change is reflected across all code, documentation, and configuration files.
  • Documentation Overhaul: The project documentation has undergone a significant restructuring and enhancement. Old doc/ and docs/ files have been reorganized, removed, or updated, and a new docs/ structure with api/, concepts/, and internals/ sections has been introduced. This includes new SVG diagrams and integration of KaTeX for mathematical rendering.
  • Funding Model Change: The .github/FUNDING.yml file has been removed, indicating a change or removal of the project's funding options.
  • Code Cleanup: Several old example and integrator files (e.g., euler_inline_op.py, leapfrog.py, rk4_numpy.py) have been removed, streamlining the codebase.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

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
Copy Markdown

@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 pull request primarily focuses on renaming the project from py_ballisticcalc to pyballistic. This is a significant and wide-ranging change that touches almost every file in the repository, including source code, documentation, configuration files, and CI/CD scripts. The renaming has been executed thoroughly.

In addition to the renaming, there's a massive overhaul of the documentation. The README.md has been simplified to a quickstart guide, and a full documentation site has been built out under the docs/ directory using mkdocs. This includes detailed API documentation, conceptual explanations, and improved examples. This is an excellent improvement that will greatly benefit users and contributors.

I've found a few minor inconsistencies related to repository URLs and names in the documentation and configuration files, likely resulting from the project being forked and renamed. My review comments focus on correcting these to ensure all links and badges work as expected.

Comment thread README.md Outdated
Comment thread docs/contributors.md
**This project exists thanks to all the people who contribute.**

<a href="https://github.com/o-murphy/py_ballisticcalc/graphs/contributors"><img height=32 src="https://contrib.rocks/image?repo=o-murphy/py_ballisticcalc" /></a>
<a href="https://github.com/dbookstaber/pyballistic/graphs/contributors"><img height=32 src="https://contrib.rocks/image?repo=o-murphy/pyballistic" /></a>
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The src attribute for the contributors image points to repo=o-murphy/pyballistic, which seems inconsistent with the repository's new location. To accurately reflect the contributors to this repository, the repo parameter should be updated to dbookstaber/pyballistic.

Suggested change
<a href="https://github.com/dbookstaber/pyballistic/graphs/contributors"><img height=32 src="https://contrib.rocks/image?repo=o-murphy/pyballistic" /></a>
<a href="https://github.com/dbookstaber/pyballistic/graphs/contributors"><img height=32 src="https://contrib.rocks/image?repo=dbookstaber/pyballistic" /></a>

Comment thread mkdocs.yml Outdated
@dbookstaber dbookstaber merged commit 21df436 into master Sep 15, 2025
169 checks passed
@dbookstaber dbookstaber deleted the renaming branch September 17, 2025 20:09
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.

2 participants