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.

Sign up for GitHub

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

Jump to bottom

Docstrings #109

Merged
merged 27 commits into from
Feb 21, 2024
Merged

Docstrings #109

merged 27 commits into from
Feb 21, 2024

Conversation

mzouink
Copy link
Member

@mzouink mzouink commented Feb 15, 2024

No description provided.

@mzouink mzouink linked an issue Feb 15, 2024 that may be closed by this pull request
Docstrings for HotDistance and InnerDistance, etc. #94
Closed
@mzouink mzouink changed the title Docstrings - no ready ro merge Docstrings - not ready ro merge Feb 15, 2024
@rhoadesScholar
Format Python code with psf/black push (#110)
2ebd939 
There appear to be some python formatting errors in
fa74081. This pull request
uses the [psf/black](https://github.com/psf/black) formatter to fix
these issues.
@cmalinmayor
Copy link
Contributor

cmalinmayor commented Feb 15, 2024 •
edited
Loading

Can build docs locally (after installing pip install -e .[dev, docs] by running sphinx-build docs/source docs/dist and then view the website by opening docs/dist/index.html. (After merging dev/main into this branch)

@rhoadesScholar rhoadesScholar changed the base branch from main to dev/main February 15, 2024 21:47
@mzouink mzouink changed the title Docstrings - not ready ro merge Docstrings - not ready to merge Feb 15, 2024
rhoadesScholar
rhoadesScholar previously approved these changes Feb 15, 2024
View reviewed changes
@rhoadesScholar rhoadesScholar changed the title Docstrings - not ready to merge Docstrings Feb 15, 2024
@rhoadesScholar rhoadesScholar marked this pull request as draft February 15, 2024 23:44
@mzouink
Copy link
Member Author

mzouink commented Feb 16, 2024

Ready to be checked !

@mzouink
Copy link
Member Author

mzouink commented Feb 16, 2024

@rhoadesScholar is not draft anymore

@mzouink
Copy link
Member Author

mzouink commented Feb 20, 2024

@cmalinmayor can you please add doc generation process to CONTRIBUTING.md

@rhoadesScholar rhoadesScholar marked this pull request as ready for review February 20, 2024 16:10
@rhoadesScholar rhoadesScholar merged commit 415a7b3 into dev/main Feb 21, 2024
0 of 6 checks passed
@rhoadesScholar rhoadesScholar deleted the docstrings branch February 21, 2024 21:23
@rhoadesScholar rhoadesScholar mentioned this pull request Feb 22, 2024
Merged
rhoadesScholar added a commit that referenced this pull request Feb 22, 2024
@rhoadesScholar
Revert "Docstrings" (#137)
f034bdf 
Reverts #109

Fix ChatGPT errors before merging.
@rhoadesScholar rhoadesScholar restored the docstrings branch February 22, 2024 05:04
@rhoadesScholar rhoadesScholar deleted the docstrings branch March 11, 2024 20:28
@mzouink mzouink restored the docstrings branch March 13, 2024 14:01
@mzouink mzouink deleted the docstrings branch March 14, 2024 03:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cmalinmayor cmalinmayor cmalinmayor left review comments

@rhoadesScholar rhoadesScholar rhoadesScholar approved these changes

Assignees
No one assigned
Labels
None yet
Projects
DaCapo Hackathon 2024
Status: Release
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docstrings for HotDistance and InnerDistance, etc.
3 participants
@mzouink @cmalinmayor @rhoadesScholar