-
Notifications
You must be signed in to change notification settings - Fork 0
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
Docstrings #76
Merged
Merged
Docstrings #76
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It says test / test (push) Failing after 2m is that a problem? |
I should be fixed, if you check the test failure it's just because the CI check is not getting the install right - https://github.com/deepskies/DeepDiagnostics/actions/runs/9619697967/job/26536380866?pr=76#step:10:1 The issue is with the CICD pipeline not the code. (Though it still needs to be fixed). |
This was referenced Jun 24, 2024
Closed
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Docstrings and putting those docstrings in rst based auto-docs.
Docs can be seen locally by installing the project (according to the readme), and then running
This makes a folder in docs called
html
with the documentation. Open the index.html file in any web browser and click away.Tried to make sure I had no grammar or spelling mistakes but that's a real high bar for my little brain sometimes. Feel free to review and tell me I've spelled something horrifically wrong.