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?
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
Most helpful comment
I like the idea of using C#'s
RemarkandSummary, it would be familiar phrasing, at least for the portion of our userbase that uses Intellisense _cough_