Feature: Add documentation

sagemath · Oct 7, 2021 · 9ee3243 · 9ee3243
1 parent d7bd9c4
commit 9ee3243
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/src/sage/features/__init__.py b/src/sage/features/__init__.py
@@ -93,6 +93,16 @@ class Feature(TrivialUniqueRepresentation):
     r"""
     A feature of the runtime environment
 
+    INPUT:
+
+    - ``name`` -- (string) name of the feature; this should be suitable as an optional tag
+      for the Sage doctester, i.e., lowercase alphanumeric with underscores (``_``) allowed;
+      features that correspond to Python modules/packages may use periods (``.``)
+
+    - ``spkg`` -- (string) name of the SPKG providing the feature
+
+    - ``url`` -- a URL for the upstream package providing the feature
+
     Overwrite :meth:`_is_present` to add feature checks.
 
     EXAMPLES::