Mention Metadata.BinaryHeaderSuffix in xmldoc comments of Metadata.En…

[voroninp]

…try constructor and in message of ArgumentException. (#2025)

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: voroninp / name: Pavel Voronin (fde7f2d)

[voroninp]

Hm, locally tests passed, but here they are failing...

[JamesNK]

Hi, I like the improvement. A couple of changes:

1. Just say what the -bin suffix is in comments.
2. Replaced inhertdoc with copy and paste. These don't change much, and it's easier to see exactly what the comment when looking at source.

[voroninp]

@JamesNK But if comments do not mention BinaryHeaderSuffix, won't people define the const one more time in their code?

[JamesNK]

@JamesNK But if comments do not mention BinaryHeaderSuffix, won't people define the const one more time in their code?

Good point. Updated comments. Thanks!

[voroninp]

@JamesNK Btw, it may be a bit extreme, but what do you think of renaming key to keyWithBinaryHeaderSuffix for the overload which accepts bytes?

public void Add(string keyWithBinaryHeaderSuffix, byte[] valueBytes)

[JamesNK]

I don't think it's necessary. Also, it's a breaking change for anyone using named parameters.