[PROTON-2248] [c] Codec pn_data_vfill() method doc has symbol and string types interchanged

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: proton-c-0.34.0
• Component/s: proton-c
• Assignee: Andrew Stitcher
• Reporter: Kim van der Riet
• Created: 09/Jul/20 15:54
• Updated: 12/Apr/21 08:34
• Resolved: 31/Mar/21 22:10

Description

The pn_data_vfill() method in codec.c:571 has the symbol and string types interchanged. The function documentation states:

/* Format codes:
   code: AMQP-type (arguments)
   ...
   S: symbol (char*)
   s: string (char*)
   ...
 */

but uses these the other way around, ie s for symbol and S for string:

          if (code == 'S') {
            err = pn_data_put_string(data, pn_bytes(size, start));
          } else {
            err = pn_data_put_symbol(data, pn_bytes(size, start));
          }

Guidance is needed on whether to fix the reversal and keep the stated codes, or reverse the codes.