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

Docs: fix documentation and type hints where functions may return None #148

Conversation

elliot-100
Copy link
Collaborator

@elliot-100 elliot-100 commented Jul 26, 2024

This PR:

  • Corrects docstrings and return type hints in Spond.spond where API retrieval functions may return None
  • Simplifies those docstrings and makes them more consistent
  • Doesn't address similar issues in Spond.club as there are key differences with the code, and I don't have any transactions to test

It should not have any effect at all at runtime.

@elliot-100 elliot-100 added bug Something isn't working documentation Improvements or additions to documentation labels Jul 26, 2024
@elliot-100 elliot-100 force-pushed the 147-correct-documentation-and-type-hints-where-functions-may-return-none branch 2 times, most recently from 5f8a127 to 1b5a823 Compare July 26, 2024 17:13
@elliot-100 elliot-100 marked this pull request as ready for review July 26, 2024 17:14
@elliot-100 elliot-100 self-assigned this Aug 2, 2024
@elliot-100 elliot-100 force-pushed the 147-correct-documentation-and-type-hints-where-functions-may-return-none branch from 1b5a823 to 4a1f516 Compare August 2, 2024 09:53
@elliot-100 elliot-100 marked this pull request as draft August 2, 2024 09:55
@elliot-100 elliot-100 force-pushed the 147-correct-documentation-and-type-hints-where-functions-may-return-none branch from 4a1f516 to a39e43c Compare August 14, 2024 14:43
@elliot-100 elliot-100 marked this pull request as ready for review August 14, 2024 14:45
@elliot-100 elliot-100 merged commit a39e43c into Olen:main Aug 22, 2024
5 checks passed
@elliot-100 elliot-100 deleted the 147-correct-documentation-and-type-hints-where-functions-may-return-none branch August 22, 2024 08:46
@elliot-100 elliot-100 linked an issue Sep 6, 2024 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Correct documentation and type hints where functions may return None
1 participant