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

Issue docstring harmonic #541

Merged
merged 4 commits into from
Sep 30, 2024

Conversation

jaclark5
Copy link
Contributor

Remove .vscode settings and have the docstring for the HarmonicOscillator be consistent with the code.

Copy link
Collaborator

@mrshirts mrshirts left a comment

Choose a reason for hiding this comment

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

This looks good to me. Reminds me we need to do a full switch over to u_kn vs u_kln in examples . . . .

@jaclark5 jaclark5 force-pushed the issue_docstring_harmonic branch from 2f5a09f to 495792a Compare September 18, 2024 17:35
@jaclark5
Copy link
Contributor Author

Failure due to pylint issues that are unrelated.

@mikemhenry
Copy link
Contributor

Why remove .vscode/ from .gitignore? It helps people from accidentally checking in files we don't want to track.

@mikemhenry
Copy link
Contributor

Thanks for the docstring fixes!

@jaclark5
Copy link
Contributor Author

jaclark5 commented Sep 27, 2024

Why remove .vscode/ from .gitignore? It helps people from accidentally checking in files we don't want to track.

I found this to be an issue when I tried to add some words to my personal VS Code settings and they were added to this file. At that point, git wanted to add my settings to your repository. I thought it would be better to delete a random person's vs code settings with their python path so that I could have my own personal settings, and other people would also avoid adding their personal settings to your repository.

@mikemhenry
Copy link
Contributor

AH! Wow okay -- so I didn't realize that we were tracking .vscode/ in this repository (I was so confused by your response since not tracking that folder is exactly what prevents your issue).

Instead of removing it from the git ignore, can you

  1. add .vscode/ back to the git ignore file
  2. backup your .vscode/ folder/settings you want for this repo
  3. run git rm -rf .vscode/
  4. commit the result
  5. now you can copy your folder back into the repo and you should be able to have your custom settings + git won't ask you to add them to the repo

That is how it should have been setup from the start -- sorry for the confusion and I am really grateful for your contribution!

@jaclark5
Copy link
Contributor Author

@mikemhenry This PR both deletes the vscode files you were carrying in the repository and adds vscode files to gitignore to prevent this issue in the future.

@mikemhenry mikemhenry merged commit 9091c3f into choderalab:master Sep 30, 2024
16 of 17 checks passed
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.

3 participants