Commit de9f1c94 authored by Christopher Toth's avatar Christopher Toth

Minor English cleanups in flask_admin.contrib.fileadmin

parent ba84a1af
...@@ -162,7 +162,7 @@ class FileAdmin(BaseView, ActionsMixin): ...@@ -162,7 +162,7 @@ class FileAdmin(BaseView, ActionsMixin):
:param base_url: :param base_url:
Base URL for the files Base URL for the files
:param name: :param name:
Name of this view. If not provided, will be defaulted to the class name. Name of this view. If not provided, will default to the class name.
:param category: :param category:
View category View category
:param endpoint: :param endpoint:
...@@ -171,7 +171,7 @@ class FileAdmin(BaseView, ActionsMixin): ...@@ -171,7 +171,7 @@ class FileAdmin(BaseView, ActionsMixin):
URL for view URL for view
:param verify_path: :param verify_path:
Verify if path exists. If set to `True` and path does not exist Verify if path exists. If set to `True` and path does not exist
will throw exception. will raise an exception.
""" """
self.base_path = base_path self.base_path = base_path
self.base_url = base_url self.base_url = base_url
...@@ -198,7 +198,7 @@ class FileAdmin(BaseView, ActionsMixin): ...@@ -198,7 +198,7 @@ class FileAdmin(BaseView, ActionsMixin):
def is_accessible_path(self, path): def is_accessible_path(self, path):
""" """
Verify if path is accessible for current user. Verify if the provided path is accessible for the current user.
Override to customize behavior. Override to customize behavior.
...@@ -242,7 +242,7 @@ class FileAdmin(BaseView, ActionsMixin): ...@@ -242,7 +242,7 @@ class FileAdmin(BaseView, ActionsMixin):
def is_file_editable(self, filename): def is_file_editable(self, filename):
""" """
Verify if file can be edited. Determine if the file can be edited.
Override to customize behavior. Override to customize behavior.
...@@ -261,7 +261,7 @@ class FileAdmin(BaseView, ActionsMixin): ...@@ -261,7 +261,7 @@ class FileAdmin(BaseView, ActionsMixin):
def is_in_folder(self, base_path, directory): def is_in_folder(self, base_path, directory):
""" """
Verify if `directory` is in `base_path` folder Verify that `directory` is in `base_path` folder
:param base_path: :param base_path:
Base directory path Base directory path
...@@ -319,9 +319,9 @@ class FileAdmin(BaseView, ActionsMixin): ...@@ -319,9 +319,9 @@ class FileAdmin(BaseView, ActionsMixin):
""" """
Verify and normalize path. Verify and normalize path.
If path is not relative to the base directory, will throw 404 exception. If the path is not relative to the base directory, will raise a 404 exception.
If path does not exist, will also throw 404 exception. If the path does not exist, this will also raise a 404 exception.
""" """
base_path = self.get_base_path() base_path = self.get_base_path()
...@@ -353,7 +353,7 @@ class FileAdmin(BaseView, ActionsMixin): ...@@ -353,7 +353,7 @@ class FileAdmin(BaseView, ActionsMixin):
Index view method Index view method
:param path: :param path:
Optional directory path. If not provided, will use base directory Optional directory path. If not provided, will use the base directory
""" """
# Get path and verify if it is valid # Get path and verify if it is valid
base_path, directory, path = self._normalize_path(path) base_path, directory, path = self._normalize_path(path)
...@@ -406,7 +406,7 @@ class FileAdmin(BaseView, ActionsMixin): ...@@ -406,7 +406,7 @@ class FileAdmin(BaseView, ActionsMixin):
Upload view method Upload view method
:param path: :param path:
Optional directory path. If not provided, will use base directory Optional directory path. If not provided, will use the base directory
""" """
# Get path and verify if it is valid # Get path and verify if it is valid
base_path, directory, path = self._normalize_path(path) base_path, directory, path = self._normalize_path(path)
...@@ -439,7 +439,7 @@ class FileAdmin(BaseView, ActionsMixin): ...@@ -439,7 +439,7 @@ class FileAdmin(BaseView, ActionsMixin):
Directory creation view method Directory creation view method
:param path: :param path:
Optional directory path. If not provided, will use base directory Optional directory path. If not provided, will use the base directory
""" """
# Get path and verify if it is valid # Get path and verify if it is valid
base_path, directory, path = self._normalize_path(path) base_path, directory, path = self._normalize_path(path)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment