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

Documentation for QPro Classes #229

Open
DanCocking opened this issue Feb 5, 2023 · 1 comment
Open

Documentation for QPro Classes #229

DanCocking opened this issue Feb 5, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation maintenance Improvements for the maintainability

Comments

@DanCocking
Copy link
Collaborator

Please describe the expected enhancement

While trying to come up with a solution for issue #227 I ran into difficulties understanding exactly how protocols worked (especially with properties such as super and subsystem). If this was documented it would make it significantly easier for anyone in the future to understand and greatly save time for anyone working on the code who has forgotten any functionality.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 5, 2023
@DanCocking DanCocking added the maintenance Improvements for the maintainability label Feb 5, 2023
@DanCocking DanCocking self-assigned this Feb 5, 2023
@github-actions
Copy link

github-actions bot commented Feb 5, 2023

Branch doc-229-Documentation_for_QPro_Classes created!

github-actions bot pushed a commit that referenced this issue Feb 5, 2023
DanCocking added a commit that referenced this issue Feb 6, 2023
The FIXME's are areas that likely need refactoring to be more clear or
to be more efficient.
The FIXME CHECK's are areas that need special attention in review.
DanCocking added a commit that referenced this issue Feb 8, 2023
Ensure it can run on all systems
DanCocking added a commit that referenced this issue Feb 8, 2023
Ensure it can run on all systems
DanCocking added a commit that referenced this issue Feb 8, 2023
Mostly ordering issues that limit functionality
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation maintenance Improvements for the maintainability
Projects
None yet
Development

No branches or pull requests

1 participant