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

Improved commenting at the top of parent files containing instructions for use. #131

Closed
tkevinbest opened this issue Oct 17, 2023 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@tkevinbest
Copy link
Member

🚀 Feature Request

It would be nice to add a comment block at the top of each file (such as state_machine.py) that describes how the modules should be used. For example, right now the State class is the first thing someone sees when they open the file which should never really be used on its own (unless I'm missing something). Basically I think we need something in each file that says how to use the components contained within that file in the intended way.

@tkevinbest tkevinbest added the enhancement New feature or request label Oct 17, 2023
@tkevinbest
Copy link
Member Author

Similarly, it'd be helpful to know that logger.py is referenced by the OSL class and you don't have to instantiate it manually.

@jderosia jderosia self-assigned this Dec 2, 2023
@senthurayyappan
Copy link
Member

Fixed with Jace's PR!

@senthurayyappan senthurayyappan moved this to Projects in opensourceleg May 6, 2024
@senthurayyappan senthurayyappan moved this from Projects to In review in opensourceleg May 6, 2024
@senthurayyappan senthurayyappan moved this from In review to Done in opensourceleg May 6, 2024
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: Done
Development

No branches or pull requests

3 participants