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...
garlick · Oct 27, 2023 · 096d83d · 096d83d
1 parent 1fc5fbb
commit 096d83d
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git 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
@@ -774,3 +774,4 @@ cwFQ
 uAsjAo
 resched
 func
+rfc
Original file line number	Diff line number	Diff line change
Expand Up		@@ -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`
-Original file line number
+Diff line change
@@ Expand Up / @@ -774,3 +774,4 @@ cwFQ @@
     uAsjAo
     resched
     func
+    rfc