From 096d83d1a37f5ece188300fce46c1fe25a782afb Mon Sep 17 00:00:00 2001 From: Jim Garlick Date: Thu, 26 Oct 2023 20:10:43 -0700 Subject: [PATCH] flux-job(3): improve RFC reference Problem: reference to RFC 34 in the RESOURCE section is a spelled out URI which is ugly in both HTML and man renderings. Use a doc reference to the RFC page so at least the HTML rendering is a little nicer. The man reference is now just the title but man doesn't support hyperlinks and the title can be googled... --- doc/man1/flux-job.rst | 2 +- doc/test/spell.en.pws | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/man1/flux-job.rst b/doc/man1/flux-job.rst index d20ceaf3fe33..8b1773ce3b68 100644 --- a/doc/man1/flux-job.rst +++ b/doc/man1/flux-job.rst @@ -317,5 +317,5 @@ RESOURCES Flux: http://flux-framework.org -RFC 34: Flux Task Map: https://flux-framework.readthedocs.io/projects/flux-rfc/en/latest/spec_34.html +:doc:`rfc:spec_34` diff --git a/doc/test/spell.en.pws b/doc/test/spell.en.pws index 635eb1657637..f9840c779bc3 100644 --- a/doc/test/spell.en.pws +++ b/doc/test/spell.en.pws @@ -774,3 +774,4 @@ cwFQ uAsjAo resched func +rfc