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

Code doc conventions: pipe for type union + * for splats

XMLWordPrintableJSON

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

      This ticket is to go through the Mongoid code comments and apply the following conventions:

      1. Pipe char to indicate a union of possible types (as opposed to comma)
      2. Splats indicated by leading * char in the param name

      Both conventions appear below:

      1. @param [ String | Symbol ] *fields Field to tally.

       

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

              Created:
              Updated:
              Resolved:
              None
              None
              None
              None