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

Add comment-documentation for several key Theia utility classes #13324

Merged
merged 5 commits into from
Feb 5, 2024

Commits on Jan 26, 2024

  1. Adds comment-documentation for several key Theia utility classes:

       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 committed Jan 26, 2024
    Configuration menu
    Copy the full SHA
    8e19f94 View commit details
    Browse the repository at this point in the history
  2. Fix typo

    jcortell68 committed Jan 26, 2024
    Configuration menu
    Copy the full SHA
    d74cef1 View commit details
    Browse the repository at this point in the history

Commits on Feb 2, 2024

  1. Adjust DisposableCollection description

    Improved description based on Martin's feedback.
    jcortell68 committed Feb 2, 2024
    Configuration menu
    Copy the full SHA
    0405e91 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    020df9c View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    51a08fd View commit details
    Browse the repository at this point in the history