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

Define, and comment the public interface of the module #9

Open
SzamosiMate opened this issue Jan 26, 2025 · 0 comments
Open

Define, and comment the public interface of the module #9

SzamosiMate opened this issue Jan 26, 2025 · 0 comments
Labels
enhancement New feature or request

Comments

@SzamosiMate
Copy link
Owner

Review the module, and:

  • add docstring comment to the functions that should be called by users
  • mark other metheds as protected

Is there a good strategy to keep comments up-to date?

@SzamosiMate SzamosiMate added the enhancement New feature or request label Jan 26, 2025
@SzamosiMate SzamosiMate added this to the v0.3.0 - Pypi relese milestone Jan 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: No status
Development

No branches or pull requests

1 participant