Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.
Sign upQuery description field location is less discoverable #2714
Comments
emtwo
referenced this issue
Aug 1, 2018
Closed
Adding a description for queries is no longer possible #474
This comment has been minimized.
This comment has been minimized.
It moved to make room for the new tags feature while making sure we don't push down the main content (query/visualization) too much down. We're open to suggestions though and even more so happy to learn how you use query descriptions. cc: @kocsmy |
This comment has been minimized.
This comment has been minimized.
@emtwo can you please share some examples of how you use this field at Mozilla? Thanks! |
This comment has been minimized.
This comment has been minimized.
@arikfr Different people may be using that field differently at Mozilla. However, the most common use-case I've seen is simply to provide a description of a visualization to help a user understand it. Here is one example: |
This comment has been minimized.
This comment has been minimized.
@arikfr where did we move this, in 5.0? I can't specifically remember and on 4.0 it's still next to the header (and it's not really pushing down the content if the query header isn't super long): |
arikfr
referenced this issue
Nov 14, 2018
Open
Add Query Parameters and Snippets to the left area of the query editor #2645
This comment has been minimized.
This comment has been minimized.
To add another use case: in addition to explaining the results of a query, we also use descriptions to explain parameters and sometimes even the query itself when multiple people are editing a query. So ideally the description would be placed before all of that. |
This comment has been minimized.
This comment has been minimized.
@sreynen thank you for the additional use case! We tried to keep the top section minimal so it won't push down the query editor and results. What if we kept the description where it is now or even behind some button in the edit mode of the query, but moved it up in the results mode? (see #3087 for new layout of results only view) Calling @ranbena to join the discussion :) |
This comment has been minimized.
This comment has been minimized.
Let's continue discussion in Discussion #3099 |
emtwo commentedAug 1, 2018
I'm not sure if this was on purpose, but it seems that the field for adding a description for a query has moved to the bottom left corner of the query editor which is slightly less discoverable in my opinion than right next to the query title.
