Changeset b297ba9 in sasmodels for sasmodels/rst2html.py

Timestamp:

Mar 20, 2019 5:03:50 PM (5 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

master, core_shell_microgels, magnetic_model, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests

Children:

4e28511

Parents:

0d362b7

Message:

lint

File:

• sasmodels/rst2html.py (modified) (10 diffs)

sasmodels/rst2html.py

@@ -142 +142 @@
 
 def load_rst_as_html(filename):
+    # type: (str) -> str
+    """Load rst from file and convert to html"""
     from os.path import expanduser
     with open(expanduser(filename)) as fid:
@@ -149 +151 @@
 
 def wxview(html, url="", size=(850, 540)):
+    # type: (str, str, Tuple[int, int]) -> "wx.Frame"
+    """View HTML in a wx dialog"""
     import wx
     from wx.html2 import WebView
@@ -158 +162 @@
 
 def view_html_wxapp(html, url=""):
+    # type: (str, str) -> None
+    """HTML viewer app in wx"""
     import wx  # type: ignore
     app = wx.App()
@@ -164 +170 @@
 
 def view_url_wxapp(url):
+    # type: (str) -> None
+    """URL viewer app in wx"""
     import wx  # type: ignore
     from wx.html2 import WebView
@@ -174 +182 @@
 
 def qtview(html, url=""):
+    # type: (str, str) -> "QWebView"
+    """View HTML in a Qt dialog"""
     try:
         from PyQt5.QtWebKitWidgets import QWebView
@@ -186 +196 @@
 
 def view_html_qtapp(html, url=""):
+    # type: (str, str) -> None
+    """HTML viewer app in Qt"""
     import sys
     try:
@@ -196 +208 @@
 
 def view_url_qtapp(url):
+    # type: (str) -> None
+    """URL viewer app in Qt"""
     import sys
     try:
@@ -217 +231 @@
 
 def can_use_qt():
+    # type: () -> bool
     """
     Return True if QWebView exists.
@@ -233 +248 @@
 
 def view_help(filename, qt=False):
+    # type: (str, bool) -> None
+    """View rst or html file.  If *qt* use q viewer, otherwise use wx."""
     import os
 
@@ -252 +269 @@
 
 def main():
+    # type: () -> None
+    """Command line interface to rst or html viewer."""
     import sys
     view_help(sys.argv[1], qt=False)