search

choderalab / pymbar

Python implementation of the multistate Bennett acceptance ratio (MBAR)
http://pymbar.readthedocs.io
MIT License
240 stars 93 forks source link

Issue docstring harmonic #541

Closed jaclark5 closed 1 month ago

jaclark5 commented 2 months ago

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

jaclark5 commented 2 months ago

Failure due to pylint issues that are unrelated.

mikemhenry commented 1 month ago

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

mikemhenry commented 1 month ago

Thanks for the docstring fixes!

jaclark5 commented 1 month ago

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 commented 1 month ago

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 1) backup your .vscode/ folder/settings you want for this repo 1) run git rm -rf .vscode/ 1) commit the result 1) 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 commented 1 month ago

@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.