New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Special-case Nullable`1 in Lua API docs #15772

Open
Phrohdoh opened this Issue Nov 1, 2018 · 0 comments

Comments

Projects
None yet
2 participants
@Phrohdoh
Member

Phrohdoh commented Nov 1, 2018

Using Media.DisplayMessage from https://github.com/OpenRA/OpenRA/wiki/Lua-API as an example:

void DisplayMessage(string text, string prefix = Mission, Nullable`1 color = nil)

It'd probably be more clear to those not familiar with C#/CLR if we had the following:

void DisplayMessage(string text, string prefix = Mission, T color = nil)

Where T is the generic type from Nullable<T>.

This way the API consumers can see the actual type and won't be bothered with a CLR type that doesn't matter to them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment