Small changes made while adding point source to new workflow#47
Small changes made while adding point source to new workflow#47AndrewRidden-Harper merged 20 commits intomainfrom
Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @AndrewRidden-Harper, 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 introduces a couple of minor but important improvements to the source_modelling/gsf.py module. These changes primarily focus on improving the robustness of file output operations by ensuring necessary directories exist and updating an outdated documentation link, all in support of ongoing work to integrate point sources into a new workflow.
Highlights
- Documentation Update: Updated the documentation link within the
gsf.pymodule's docstring. The old link was outdated or broken, and the new one points to the current GSF file format specification on the QuakeCore wiki. - File System Robustness: Enhanced the
write_gsffunction to automatically create the parent directories for the output GSF file if they do not already exist. This prevents potentialFileNotFoundErrorissues and makes the function more robust when writing files to new directory structures.
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
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request introduces two small changes: updating a URL in a docstring and making the write_gsf function create the output directory if it doesn't exist. The changes are reasonable. My review includes one suggestion to document the new directory creation behavior in the function's docstring to make this side-effect clear to future users.
lispandfound
left a comment
There was a problem hiding this comment.
Yeah these seem pretty inconspicuous
|
@joelridden @lispandfound @sungeunbae This PR has been approved by @lispandfound, but it needs more approvals before it can be merged |
This PR has some small changes that I made while adding point sources to the new workflow (this PR)