Improve Nullable documentation

[MetaLang]

• Add documented unittests for member functions
• Add new examples
• Document some behavioural quirks
• Add Params, Returns and Throws where appropriate

For some reason the alias get this won't show up in the generated DDOC. I guess that must be a bug. Also, is there a way to link to the second "overload" of Nullable in the documentation of the first? I couldn't figure out how to do it.

[JakobOvrum]

s/iff/if/

edit:

Nevermind, I see now it is intentional.

[MetaLang]

I have removed the Throws clause for the time being, but I'm not convinced that it shouldn't be part of the interface of Nullable.get, especially if the check is moved to an in contract. I did not move the check into an in contract as I don't want to change any semantics with this pull, only documentation.

[JakobOvrum]

The preconditions are part of the interface, but what happens if a precondition is not met should not be.

If a precondition or assert is not met, it is a logic error. We throw various kinds of Errors, but they are not recoverable and not even guaranteed to be catchable. As you mentioned in the docs, they are not even guaranteed to be thrown. It's not useful to limit ourselves to a particular implementation (the sum of the behaviour of both the source code and the compiler) when it doesn't empower the user in any way.

[MetaLang]

Ping

[JakobOvrum]

LGTM

[JakobOvrum]

Auto-merge toggled on