Skip to content
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

API Layout Suggestion: put "Syntax" at the top #5

Open
SilentSin opened this issue May 5, 2019 · 0 comments
Open

API Layout Suggestion: put "Syntax" at the top #5

SilentSin opened this issue May 5, 2019 · 0 comments

Comments

@SilentSin
Copy link

It seems to me that the syntax is even more important than the summary so it should go right under the member heading.

And the Assembly/Namespace/ContainingType should be moved a bit out of the way such as in the top right or even the top left where it already shows the containing type. That section is obviously pretty important for types because it has the inheritance diagram, but for individual members it's always just those 3 things and you usually already know roughly where you are. They could even be shown on a single line at the top: Assembly.dll -> Namespace.ContainingType.

image

Also, I believe C# actually calls it the "Declaring Type" rather than "Containing Type".

@daveaglick daveaglick transferred this issue from statiqdev/Statiq.Web Feb 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant