Search Unity

  1. Unity 6 Preview is now available. To find out what's new, have a look at our Unity 6 Preview blog post.
    Dismiss Notice
  2. Unity is excited to announce that we will be collaborating with TheXPlace for a summer game jam from June 13 - June 19. Learn more.
    Dismiss Notice

Feedback Show Help icon only if [HelpURL] has actually been specified

Discussion in 'Editor & General Support' started by Peter77, Jul 9, 2019.

  1. Peter77

    Peter77

    QA Jesus

    Joined:
    Jun 12, 2013
    Posts:
    6,629
    Unity displays in the Inspector a help icon for every component. It's this book icon with the ? symbol.

    upload_2019-7-9_17-45-25.png

    If you click the help icon, Unity opens a web-browser and opens the corresponding help page for that particular component.

    Unless... there has no HelpURL been specified, like in the "Debug Draw Sample 1" Component in the above screenshot.

    In this case, Unity tries to open a non-existent page, such as this one. I noticed this with so many Unity components that are provided through packages.

    I suggest to display the help icon only, if there has been a HelpURL attribute provided. If it's missing, either display the icon in an inactive (aka grayed-out) state or hide it entirely.

    This prevents users from clicking this icon just to find there exist no documentation. Perhaps it also causes developers to be more aware where those HelpURL attributes are missing.
     
  2. Xarbrough

    Xarbrough

    Joined:
    Dec 11, 2014
    Posts:
    1,188
    I second this. My team uses the HelpURL attribute for custom components and links to internal confluence documentation pages. However, we couldn't adopt the principle because in the beginning everyone was starting to click on these icons and reported broken documentation links to me in cases where there's simply no page for that component. Now nobody wants to use the icon anymore because users don't know which of them should point to a page.
     
    Crucifer-UA, FlaSh-G and Peter77 like this.
  3. Peter77

    Peter77

    QA Jesus

    Joined:
    Jun 12, 2013
    Posts:
    6,629
    Just running into this annoyance over and over. Please consider to implement my suggestion above. It seems like a trivial fix to me, but has a huge benefit.
     
    Crucifer-UA and Xarbrough like this.
  4. Peter77

    Peter77

    QA Jesus

    Joined:
    Jun 12, 2013
    Posts:
    6,629
    @Aras Is this perhaps something for your Quality of Life team?
     
    Xarbrough likes this.