Add comment & docstring

Author: i80and

snooty/intersphinx.py

@@ -49,6 +49,8 @@ def __getitem__(self, target: str) -> TargetDefinition:
         return self.targets[target]
 
     def dumps(self, name: str, version: str) -> bytes:
+        """Serialize this inventory in the Intersphinx inventory format, and
+           return the resulting bytes."""
         # Newlines break the (fragile) format; let's just be safe and make sure we're not smuggling any in.
         if "\n" in name:
             raise ValueError(name)

snooty/test_intersphinx.py

@@ -10,7 +10,8 @@
 EXPECTED_INVENTORY_FILENAME = "docsmongodbcommanualobjectsinv"
 INVENTORY_PATH = TESTING_CACHE_DIR.joinpath(EXPECTED_INVENTORY_FILENAME)
 
-# Skip footnote labels during validation
+# Skip footnote labels during validation. Yes, these are all labels created
+# by footnotes.
 IGNORE_TARGETS = {
     "std:label:hashes",
     "std:label:update-correctness",