Uploaded image for project: 'Beam'
  1. Beam
  2. BEAM-1448

Coder encode/decode context documentation is lacking

    XMLWordPrintableJSON

Details

    Description

      Coder encode/decode context documentation is lacking.

      • Documentation of Coder methods encode and decode should include description of context argument and explain how to relate to it when implementing.
      • Consider renaming the static Context values NESTED and OUTER to more accurate names.
      • Emphasize the use of CoderProperties as the best way to test a coder.

      Original dev list discussion

      Attachments

        Issue Links

          relates to

          Improvement - An improvement or enhancement to an existing feature or task. BEAM-2166 Remove Coder.Context from the public API

          • P2 - Default priority. Will be triaged and planned according to community practices.
          • Resolved

          Activity

            People

              Unassigned Unassigned
              aviemzur Aviem Zur
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated: