[fbsync] Indicate strings can be used to specify weights parameter (#6314)

jdsgomes · facebook-github-bot · commit 888a00b50652 · 2022-07-28T03:33:32.000-07:00
Summary:
* Indicate strings can be used to specify

* quotes

Reviewed By: datumbox

Differential Revision: D38154567

fbshipit-source-id: 09adba68a83bd4ecd281dae0d2a562974824e0bf
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -326,7 +326,8 @@ def inject_weight_metadata(app, what, name, obj, options, lines):
 
         lines[:] = [
             "The model builder above accepts the following values as the ``weights`` parameter.",
-            f"``{obj.__name__}.DEFAULT`` is equivalent to ``{obj.DEFAULT}``.",
+            f"``{obj.__name__}.DEFAULT`` is equivalent to ``{obj.DEFAULT}``. You can also use strings, e.g. "
+            f"``weights='DEFAULT'`` or ``weights='{str(list(obj)[0]).split('.')[1]}'``.",
         ]
 
         if obj.__doc__ != "An enumeration.":

Original file line number	Diff line number	Diff line change
`@@ -326,7 +326,8 @@ def inject_weight_metadata(app, what, name, obj, options, lines):`
`326`	`326`
`327`	`327`	`lines[:] = [`
`328`	`328`	"The model builder above accepts the following values as the ``weights`` parameter.",
`329`		- f"``{obj.__name__}.DEFAULT`` is equivalent to ``{obj.DEFAULT}``.",
	`329`	+ f"``{obj.__name__}.DEFAULT`` is equivalent to ``{obj.DEFAULT}``. You can also use strings, e.g. "
	`330`	+ f"``weights='DEFAULT'`` or ``weights='{str(list(obj)[0]).split('.')[1]}'``.",
`330`	`331`	`]`
`331`	`332`
`332`	`333`	`if obj.__doc__ != "An enumeration.":`