Skip to content

Conversation

@jlheflin
Copy link
Contributor

Is this pull request associated with an issue(s)?
No

Description
I wanted to adjust the xyz_to_mol module to be able to take in data from the input as a string instead of just as a file.

TODOs

  • Double check any issues get caught regarding the form of the xyz data (I think I caught all the possible cases but need some extra eyes just in case)

Copy link
Member

@jwaldrop107 jwaldrop107 left a comment

Choose a reason for hiding this comment

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

I think the changes here are mechanically fine, but I would actually advise introducing a new module entirely. Basically, split what you have here into one module whose singular focus is to parse XYZ data from a string, and another one whose purpose is to read in XYZ data from a file. The file reader module can then use the data parser as a submodule. This scheme allows for clarity of purpose in the modules and distinct names to describe what they do ("XYZ To Molecule" and "XYZ File To Molecule" for instance).

Regarding the completeness of the test cases, they seem sufficient to me.

@ryanmrichard
Copy link
Member

Agree with @jwaldrop107.

@jlheflin
Copy link
Contributor Author

I separated out the modules, the only thing I'm not super confident about is the "try, catch" code.

Copy link
Member

@jwaldrop107 jwaldrop107 left a comment

Choose a reason for hiding this comment

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

Right track, but there are some further changes I'd recommend.

Copy link
Member

@jwaldrop107 jwaldrop107 left a comment

Choose a reason for hiding this comment

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

LGTM

@jlheflin jlheflin marked this pull request as ready for review May 21, 2025 00:09
@jlheflin jlheflin merged commit 0cdd032 into master May 21, 2025
5 checks passed
@jlheflin jlheflin deleted the xyz_to_mol_patch branch May 21, 2025 00:12
@jwaldrop107
Copy link
Member

🚀 [bumpr] Bumped!
New version:v0.0.5
Changes:v0.0.4...v0.0.5

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.

4 participants