Thrift
  1. Thrift
  2. THRIFT-147

Ruby generated classes should include class doc strings

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Ruby - Compiler
    • Labels:
      None
    • Patch Info:
      Patch Available

      Description

      Generated code should include the provided docstrings (from the IDL) as RDoc on the classes. If the fields weren't generated at runtime, they should have RDoc too.

      1. thrift-147-v2.patch
        1 kB
        Bryan Duxbury
      2. thrift-147.patch
        1 kB
        Bryan Duxbury

        Issue Links

          Activity

          Hide
          Kevin Clark added a comment -

          In 709309

          Show
          Kevin Clark added a comment - In 709309
          Hide
          Kevin Clark added a comment -

          Looks good. I'll push barring objections.

          Show
          Kevin Clark added a comment - Looks good. I'll push barring objections.
          Hide
          Bryan Duxbury added a comment -

          This version conforms to the way the Java version works. It also includes per-field docstrings mixed in with the generated FIELDS constant, so that people browsing the code for schema info (like my users) can see what the fields are all about.

          Show
          Bryan Duxbury added a comment - This version conforms to the way the Java version works. It also includes per-field docstrings mixed in with the generated FIELDS constant, so that people browsing the code for schema info (like my users) can see what the fields are all about.
          Hide
          Bryan Duxbury added a comment -

          This patch uses the changes in THRIFT-179 for simplicity.

          Show
          Bryan Duxbury added a comment - This patch uses the changes in THRIFT-179 for simplicity.

            People

            • Assignee:
              Bryan Duxbury
              Reporter:
              Bryan Duxbury
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development