Links to other files are missing from website html and DevHelp docs for GVariant and possibly others
@dboles
Submitted by Daniel Boles Link to original bug (#774447)
Description
Please see the following function docs:
- https://developer.gnome.org/glib/stable/glib-GVariant.html#g-variant-parse
- https://developer.gnome.org/glib/stable/glib-GVariant.html#g-variant-print
These are widely used and form the basis of various other functions, meaning it's very important to specify the format we must pass to them.
However, neither explain the format they expect, saying only
The format is described here.
without any link on the "here", or any real indication of where we're meant to be looking - and linking circularly to each other for good measure!
So it's really not obvious what we're meant to pass as the format string to these functions.
Luckily for me, mcatanzaro was in the right place at the right time and found it: https://developer.gnome.org/glib/stable/gvariant-text.html
And indeed, following that guide solved the problem I was having (mismatched types of a GAction Variant's parameter and a target being passed to it).
My guess is those two occurrences of "here" - and any others like them - should be links to that page, so that users can determine what format they need to pass, without having to luck into it.
Thanks!
Version: 2.50.x