Uploaded image for project: 'Mongoid'
  1. Mongoid
  2. MONGOID-5141

Remove all @since comments from repo

    • Type: Icon: Improvement Improvement
    • Resolution: Fixed
    • Priority: Icon: Unknown Unknown
    • 7.4.0
    • Affects Version/s: None
    • Component/s: None
    • Fully Compatible

      @since comments are generally not useful:

      1. The project is now quite mature. @since was perhaps useful when there were radical changes between 1.0, 2.0, and 3.0, but those days are long gone.
      2. They do not reflect significant interface changes to methods
      3. They are not accurate, for example they have been kept in-place when code was moved to other classes
      4. We're not adding them on new PRs
      5. It adds clutter and makes code harder to read.

      Instead of tagging each method with @since we should simply be following Semver, and be mindful when we are change public method behavior.

            Assignee:
            oleg.pudeyev@mongodb.com Oleg Pudeyev (Inactive)
            Reporter:
            shields@tablecheck.com Johnny Shields
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: