John Snow <js...@redhat.com> writes:

> Add "the members of ..." pointers to Members and Arguments lists where
> appropriate, with clickable cross-references - so it's a slight
> improvement over the old system :)
>
> This patch is meant to be a temporary solution until we can review and
> merge the inliner.
>
> The implementation of this patch is a little bit of a hack: Sphinx is
> not designed to allow you to mix fields of different "type"; i.e. mixing
> member descriptions and free-form text under the same heading. To
> accomplish this with a minimum of hackery, we technically document a
> "dummy field" and then just strip off the documentation for that dummy
> field in a post-processing step. We use the "q_dummy" variable for this
> purpose, then strip it back out before final processing. If this
> processing step should fail, you'll see warnings for a bad
> cross-reference. (So if you don't see any, it must be working!)
>
> Signed-off-by: John Snow <js...@redhat.com>

Yes, it's a hack, and possibly fragile, but it'll all go away when the
inliner lands.  I understand the inliner already exists, but you're
holding it back to not balloon the series even more.

I'm on board.


Reply via email to