expand on the getContext() description

[andre-merzky]

Also fixes a couple of smaller issues.

[SteVwonder]

Generally LGTM! Just a few nits below.

[SteVwonder]

Nit: I would actually vote to keep the semicolon here since we are listing the three methods below it. If we want to remove the semicolon, I think the sentence should still end with some punctuation (i.e., .).

[andre-merzky]

Ack! :-)

[hategan]

What's the difference in purpose between getContext() and the existing getMetadata()?

[andre-merzky]

What's the difference in purpose between getContext() and the existing getMetadata()?

Good question - and in a different PR I wondered the same about getMessage() vs. getMetadata(). I would think we need only one of those.

[hategan]

See a8dd4e9

Their description is very similar. It even says "metadata" for "getContext()". So I think this is a duplicate and should be reverted.

We can discuss "getMessage" separately, but, for reference, it is meant to convey error messages on failed states, so I do not think it should be removed.

[andre-merzky]

See a8dd4e9

Their description is very similar. It even says "metadata" for "getContext()". So I think this is a duplicate and should be reverted.

You are probably right, and I don't mind reverting. Sorry for the confusion.

We can discuss "getMessage" separately, but, for reference, it is meant to convey error messages on failed states, so I do not think it should be removed.

I opened a ticket at #124.