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

XML references to long method signatures easily overflow the table #12

Open
SilentSin opened this issue Apr 18, 2019 · 1 comment
Open

Comments

@SilentSin
Copy link

I have a method which ends up with a particularly long documentation signature even though it only has 3 parameters:

Animancer.AnimancerPlayable.GetOrCreateState(System.Object,UnityEngine.AnimationClip,System.Int32)

So when Wyam puts a reference to it in the table and doesn't allow such references to word wrap, it ends up giving the table a horizontal scroll bar which makes it really hard to use (about half of every line is hidden):
image

Allowing it to word wrap on non-alphanumeric characters like dots and brackets instead of only whitespace would probably be an acceptable solution, though I don't know how easily the word wrapping algorithm can be changed. Perhaps there's an invisible 0 width character that gets treated as whitespace which you could insert at relevant points in the code block?

It would be awesome if the text could just be AnimancerPlayable.GetOrCreateState(object,AnimationClip,int) (without the class prefix if we're currently looking at members inside that class) and have a tooltip with the fully qualified signature that shows up when you hover over it. A tooltip wouldn't even be necessary if it just generated a link to that method (which now that I think about it is probably a bug).

Also, relating to https://github.com/Wyamio/Wyam/issues/799, it's using the full type names of int and object here instead of their keywords.

@SilentSin
Copy link
Author

Here's another one. A very long member in the summary section where you can't even see the whole thing because the page doesn't have horizontal scrolling:

image

@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