Skip to content
Snippets Groups Projects
Commit e6af7edc authored by Samuel GAIST's avatar Samuel GAIST
Browse files

[dataformat] Added missing doc and fixed doc related warnings

Also fixed import warnings
parent 8676e52d
No related branches found
No related tags found
2 merge requests!17Merge development branch 1.5.x,!13Improve documentation
...@@ -26,9 +26,14 @@ ...@@ -26,9 +26,14 @@
############################################################################### ###############################################################################
"""Validation and parsing for dataformats""" """
==========
dataformat
==========
Validation and parsing for dataformats
"""
import os
import re import re
import copy import copy
...@@ -230,7 +235,6 @@ class DataFormat(object): ...@@ -230,7 +235,6 @@ class DataFormat(object):
self.resolved.update(tmp) self.resolved.update(tmp)
del self.resolved['#extends'] # avoids infinite recursion del self.resolved['#extends'] # avoids infinite recursion
@property @property
def name(self): def name(self):
"""Returns the name of this object, either from the filename or composed """Returns the name of this object, either from the filename or composed
...@@ -271,8 +275,8 @@ class DataFormat(object): ...@@ -271,8 +275,8 @@ class DataFormat(object):
Example: Example:
To create an object respecting the data format from a JSON descriptor, use To create an object respecting the data format from a JSON
the following technique: descriptor, use the following technique:
.. code-block:: python .. code-block:: python
...@@ -335,6 +339,7 @@ class DataFormat(object): ...@@ -335,6 +339,7 @@ class DataFormat(object):
@property @property
def valid(self): def valid(self):
"""A boolean that indicates if this dataformat is valid or not"""
return not bool(self.errors) return not bool(self.errors)
...@@ -444,7 +449,8 @@ class DataFormat(object): ...@@ -444,7 +449,8 @@ class DataFormat(object):
Parameters: Parameters:
indent (int): The number of indentation spaces at every indentation level indent (int): The number of indentation spaces at every indentation
level
Returns: Returns:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment