• patrickdoc's avatar
    users-guide: Standardize and repair all flag references · 44b090be
    patrickdoc authored
    This patch does three things:
    
    1.) It simplifies the flag parsing code in `conf.py` to properly display
    flag definitions created by `.. (ghc|rts)-flag::`. Additionally, all flag
    references must include the associated arguments. Documentation has been
    added to `editing-guide.rst` to explain this.
    
    2.) It normalizes all flag definitions to a similar format. Notably, all
    instances of `<>` have been replaced with `⟨⟩`. All references across the
    users guide have been updated to match.
    
    3.) It fixes a couple issues with the flag reference table's generation code,
    which did not handle comma separated flags in the same cell and did not
    properly reference flags with arguments.
    
    Test Plan:
    `SPHINXOPTS = -n` to activate "nitpicky" mode, which reports all broken
    references. All remaining errors are references to flags without any
    documentation.
    
    Reviewers: austin, bgamari
    
    Reviewed By: bgamari
    
    Subscribers: rwbarton, thomie
    
    GHC Trac Issues: #13980
    
    Differential Revision: https://phabricator.haskell.org/D3778
    44b090be
debugging.rst 11.9 KB