refactor: rename err_markdown to err_as_html (#99)

Signed-off-by: Henry Schreiner <[email protected]>

docs/conf.py

@@ -3,8 +3,8 @@
 project = "repo-review"
 copyright = "2022, Henry Schreiner"
 author = "Henry Schreiner"
-release = importlib.metadata.version("repo-review").split("+")[0]
-version = ".".join(release.split(".")[:2])
+version = importlib.metadata.version("repo-review").split("+")[0]
+release = version
 
 extensions = [
     "myst_parser",

docs/intro.md

@@ -60,7 +60,7 @@ rather than the framework (repo-review).
 
 ## GitHub Actions
 
-```
+```yaml
 - uses: scientific-python/repo-review@<version>
   with:
     plugins: sp-repo-review

pyproject.toml

@@ -63,8 +63,8 @@ docs = [
 [project.urls]
 Changelog = "https://github.com/scientific-python/repo-review/releases"
 Demo = "https://scientific-python.github.io/repo-review"
-Documentation = "https://repo-review.readthedocs.io/"
-Homepage = "https://repo-review.readthedocs.io/"
+Documentation = "https://repo-review.readthedocs.io"
+Homepage = "https://repo-review.readthedocs.io"
 Source = "https://github.com/scientific-python/repo-review"
 
 [project.scripts]

src/repo_review/processor.py

@@ -4,6 +4,7 @@
 import graphlib
 import textwrap
 import typing
+import warnings
 from collections.abc import Mapping, Set
 from typing import Any, TypeVar
 
@@ -58,6 +59,13 @@ class Result:
     url: str = ""  #: An optional URL (empty string if missing)
 
     def err_markdown(self) -> str:
+        """
+        DEPRECATED: use err_as_html instead.
+        """
+        warnings.warn("Use err_as_html instead", FutureWarning, stacklevel=2)
+        return self.err_as_html()
+
+    def err_as_html(self) -> str:
         """
         Produces HTML from the error message, assuming it is in markdown.
         """
@@ -134,10 +142,9 @@ def process(
     """
     Process the package and return a dictionary of results.
 
-    :param root: The Path(like) to the repository to process
-
-    :param ignore: A list of checks to ignore
-
+    :param root: The Traversable to the repository to process.
+    :param select: A list of checks to select. All checks selected if empty.
+    :param ignore: A list of checks to ignore.
     :param subdir: The path to the package in the subdirectory, if not at the
                    root of the repository.