Add comment-documentation for several key Theia utility classes #13324
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
DisposableCollection AbstractReferenceCollection ReferenceCollection SyncReferenceCollection Lack of documentation, especially for non-trivial but pervasively used types is, IMO, a hindrance to the widespread adoption of the platform. Imagine STL or any other major library expecting developers to learn and understand its various facilities by reading the code line-by-line. It significantly increases the learning curve and makes the platform less approachable. Where I am having to do such line-by-line studying of the code to understand these essential utilties, I'll be making contributions to hopefully bring some relief. However, I do think this technical debt should be tackled in a more comprehensive and intentional manner now that Theia has presumably reached some sort of critical mass.
jcortell68
changed the title
martin-fleck-at
requested changes
Feb 2, 2024
jcortell68
force-pushed
the
jcortell_doc1
branch
3 times, most recently
from
a40064a to
9655e9b
Compare
Improved description based on Martin's feedback.
jcortell68
force-pushed
the
jcortell_doc1
branch
from
9655e9b to
0405e91
Compare
jcortell68
force-pushed
the
jcortell_doc1
branch
from
1b9379f to
020df9c
Compare
|
@martin-fleck-at Sorry for the churn. All done now and ready for re-review when you get a chance. |
martin-fleck-at
requested changes
Feb 2, 2024
jcortell68
force-pushed
the
jcortell_doc1
branch
from
64c2f60 to
51a08fd
Compare
|
@martin-fleck-at I think I took care of all your feedback items. Let me know if I missed something |
martin-fleck-at
approved these changes
Feb 5, 2024
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.
What it does
Adds comment-documentation for several key Theia utility classes
Lack of documentation, especially for non-trivial but pervasively used types is, IMO, a hindrance to the widespread adoption of the platform. Imagine STL or any other major library expecting developers to learn and understand its various facilities by reading the code line-by-line. It significantly increases the learning curve and makes the platform less approachable.
Where I am having to do such line-by-line studying of the code to understand these essential utilties, I'll be making contributions to hopefully bring some relief. However, I do think this technical debt should be tackled in a more comprehensive and intentional manner now that Theia has presumably reached some sort of critical mass.
How to test
Someone intimate with these utility types should read the new documentation and check for accuracy and understandability.
Follow-ups
N/A
Review checklist
Reminder for reviewers