Add docstrings (#1)

Author: Randy Zwitch

MANIFEST.in

@@ -1 +1 @@
-recursive-include streamlit_victory/frontend/build *
+

streamlit_embedcode/__init__.py

@@ -2,10 +2,48 @@
 
 
 def _clean_link(link):
+    """Strip trailing slash if present on link.
+
+    Parameters
+    ----------
+    link : str
+        URL from code sharing website
+
+    Returns
+    -------
+    str
+        Returns value of `link` without trailing slash.
+
+    Example
+    -------
+    >>> _clean_link("https://gist.github.com/randyzwitch/be8c5e9fb5b8e7b046afebcac12e5087/")
+    'https://gist.github.com/randyzwitch/be8c5e9fb5b8e7b046afebcac12e5087'
+
+    >>> _clean_link("https://gist.github.com/randyzwitch/be8c5e9fb5b8e7b046afebcac12e5087")
+    'https://gist.github.com/randyzwitch/be8c5e9fb5b8e7b046afebcac12e5087'
+    """
+
     return link[:-1] if link[-1] == "/" else link
 
 
 def github_gist(link, height=600, width=950, scrolling=True):
+    """Embed a GitHub gist.
+
+    Parameters
+    ----------
+    link : str
+        URL from https://gist.github.com/
+    height: int
+        Height of the resulting iframe
+    width: int
+        Width of the resulting iframe
+    scrolling: bool
+        If content is larger than iframe size, provide scrollbars?
+    
+    Example
+    -------
+    >>> github_gist("https://gist.github.com/randyzwitch/be8c5e9fb5b8e7b046afebcac12e5087/")
+    """
 
     gistcreator, gistid = _clean_link(link).split("/")[-2:]
     return st.html(
@@ -17,6 +55,23 @@ def github_gist(link, height=600, width=950, scrolling=True):
 
 
 def gitlab_snippet(link, height=600, width=950, scrolling=True):
+    """Embed a Gitlab snippet.
+
+    Parameters
+    ----------
+    link : str
+        URL from https://gitlab.com/explore/snippets
+    height: int
+        Height of the resulting iframe
+    width: int
+        Width of the resulting iframe
+    scrolling: bool
+        If content is larger than iframe size, provide scrollbars?
+    
+    Example
+    -------
+    >>> gitlab_snippet("https://gitlab.com/snippets/1990429/", height = 400)
+    """
 
     snippetnumber = _clean_link(link).split("/")[-1]
     return st.html(
@@ -28,6 +83,23 @@ def gitlab_snippet(link, height=600, width=950, scrolling=True):
 
 
 def pastebin_snippet(link, height=600, width=950, scrolling=True):
+    """Embed a Pastebin snippet.
+
+    Parameters
+    ----------
+    link : str
+        URL from https://pastebin.com/
+    height: int
+        Height of the resulting iframe
+    width: int
+        Width of the resulting iframe
+    scrolling: bool
+        If content is larger than iframe size, provide scrollbars?
+    
+    Example
+    -------
+    >>> pastebin_snippet("https://pastebin.com/AWYbziQF", width = 600, scrolling = False)
+    """
 
     snippetnumber = _clean_link(link).split("/")[-1]
     return st.html(
@@ -41,6 +113,28 @@ def pastebin_snippet(link, height=600, width=950, scrolling=True):
 def codepen_snippet(
     link, height=600, width=950, scrolling=True, theme="light", preview=True
 ):
+    """Embed a CodePen snippet.
+
+    Parameters
+    ----------
+    link : str
+        URL from https://codepen.io/
+    height: int
+        Height of the resulting iframe
+    width: int
+        Width of the resulting iframe
+    scrolling: bool
+        If content is larger than iframe size, provide scrollbars?
+    theme: str
+        Color theme of snippet (i.e. "light", "dark")
+    preview: bool
+        Require snippet to be clicked to load. Setting `preview=True` can improve load times.
+
+    
+    Example
+    -------
+    >>> pastebin_snippet("https://pastebin.com/AWYbziQF", width = 600, scrolling = False)
+    """
 
     user, _, slughash = _clean_link(link).split("/")[-3:]
     return st.html(
@@ -62,6 +156,23 @@ def codepen_snippet(
 
 
 def ideone_snippet(link, height=600, width=950, scrolling=True):
+    """Embed a Ideone snippet.
+
+    Parameters
+    ----------
+    link : str
+        URL from https://ideone.com/
+    height: int
+        Height of the resulting iframe
+    width: int
+        Width of the resulting iframe
+    scrolling: bool
+        If content is larger than iframe size, provide scrollbars?
+    
+    Example
+    -------
+    >>> ideone_snippet("https://ideone.com/vQ54cr")
+    """
 
     snippetnumber = _clean_link(link).split("/")[-1]
     return st.html(
@@ -70,3 +181,31 @@ def ideone_snippet(link, height=600, width=950, scrolling=True):
         width=width,
         scrolling=scrolling,
     )
+
+
+def tagmycode_snippet(link, height=600, width=950, scrolling=True):
+    """Embed a TagMyCode snippet.
+
+    Parameters
+    ----------
+    link : str
+        URL from https://tagmycode.com/
+    height: int
+        Height of the resulting iframe
+    width: int
+        Width of the resulting iframe
+    scrolling: bool
+        If content is larger than iframe size, provide scrollbars?
+    
+    Example
+    -------
+    >>> tagmycode_snippet("https://tagmycode.com/snippet/14040/css-structure#.XvYhunVKglU")
+    """
+
+    snippetnumber = _clean_link(link).split("/")[-2]
+    return st.html(
+        f"""<script src="https://tagmycode.com/embed/js/{snippetnumber}"></script>""",
+        height=height,
+        width=width,
+        scrolling=scrolling,
+    )