Discord.net: Summary/Description naming

Created on 28 Aug 2016  路  7Comments  路  Source: discord-net/Discord.Net

Names still aren't intuitive and we're getting a bit of backlash, so opening the doors for this debate again.

We need a name for a short description attribute, and one for a long description. What would work best for this?

discussion grabbed commands

Most helpful comment

I like the idea of using C#'s Remark and Summary, it would be familiar phrasing, at least for the portion of our userbase that uses Intellisense _cough_

All 7 comments

My Suggestions:
Short: Gist
Long: Summary

Short: Tag
Long: Description

I like the idea of using C#'s Remark and Summary, it would be familiar phrasing, at least for the portion of our userbase that uses Intellisense _cough_

+1 khio;

in addition to this, we could opt to bring in roslyn as a dependency and use it to automatically scrape docstrings, removing the need to annotate parameters/commands with attributes.

Not a bad idea, but would that be worth the weight? Roslyn is fairly heavy for such a thing, especially when we have alternatives

If we're all set with Remark/Summary, I'll grab that part at least.

@khionu seems good to me, i'd go ahead and ask design guild again to verify we won't need to open this up again

Resolved in #275

Was this page helpful?
0 / 5 - 0 ratings

Related issues

aequasi picture aequasi  路  3Comments

TheBlue-1 picture TheBlue-1  路  3Comments

Poyser1911 picture Poyser1911  路  4Comments

msx752 picture msx752  路  3Comments

tacitusxo picture tacitusxo  路  4Comments