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

Improve UX with namespace #57

Open
mvorisek opened this issue Jul 15, 2023 · 2 comments
Open

Improve UX with namespace #57

mvorisek opened this issue Jul 15, 2023 · 2 comments

Comments

@mvorisek
Copy link
Contributor

mvorisek commented Jul 15, 2023

Currently when NS is defined, it is prepended before every class name.

With a lot of classes, it is quite hard to visually locate the desired class (method, ...) quickly.

This is a feature request and I propose to render namespace in class name with lighter color like:

image

This feature request is only about the visual UX, anchors should remain fully qualified (as they are now).

Together with #56 fixed, this will help large projects to have NS defined to project's NS on top of each doc file.

@mvorisek
Copy link
Contributor Author

mvorisek commented Jul 15, 2023

class declaration/directives names are already separated in HTML render and can be styled:

image

the problem is with methods (constants/methods) only

the NS is rendered with short class name in 1 <span class="sig-prename">


another alternative might be to render the namespace directive like class:

image

and then not render the NS before any class

this will save a lot of visual real estate

@markstory
Copy link
Owner

another alternative might be to render the namespace directive like class:
and then not render the NS before any class.

Not all projects that document namespaced classes include a namespace directive on the page. I can see the argument for skipping the namespace prefix on every method. Perhaps this could be a good place to add a configuration option to allow either the full namespace prefix (current behavior) or just the classname, or no prefix.

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

No branches or pull requests

2 participants