Skip to content

Commit

Permalink
Improved doc
Browse files Browse the repository at this point in the history
  • Loading branch information
PonteIneptique committed Dec 13, 2016
1 parent 5c5606c commit 4dd3ba3
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 10 deletions.
3 changes: 1 addition & 2 deletions MyCapytain/common/reference.py
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ def list(self):
def subreference(self):
""" Return the subreference of a single node reference
.. note:: Access to start and end subreference should be done through obj.start.subreference
.. note:: Access to start and end subreference should be done through obj.start.subreference \
and obj.end.subreference
:rtype: (str, int)
Expand Down Expand Up @@ -297,7 +297,6 @@ class URN(object):
>>> len(a) == 5 # Reference is not counted to not induce count equivalencies with the optional version
>>> len(b) == 4
.. automethod:: upTo
"""

NAMESPACE = 0
Expand Down
2 changes: 1 addition & 1 deletion MyCapytain/resolvers/cts/local.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@


class CTSCapitainsLocalResolver(Resolver):
""" XML Folder Based resolver.
""" XML Folder Based resolver. Text and metadata resolver based on local directories
:param resource: Resource should be a list of folders retaining data as Capitains Guidelines Repositories
:type resource: [str]
Expand Down
7 changes: 0 additions & 7 deletions MyCapytain/resources/collections/cts.py
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,6 @@ def xpathDict(xml, xpath, children, parents, **kwargs):
class Text(cts.Text):
""" Represents a CTS Text
..automethod:: __str__
"""
def __init__(self, **kwargs):
super(Text, self).__init__(**kwargs)
Expand Down Expand Up @@ -305,8 +304,6 @@ def Translation(resource=None, urn=None, parents=None):
class Work(cts.Work):

""" Represents a CTS Textgroup in XML
..automethod:: __str__
"""

def __init__(self, **kwargs):
Expand Down Expand Up @@ -406,8 +403,6 @@ def parse(self, resource):
class TextGroup(cts.TextGroup):

""" Represents a CTS Textgroup in XML
.. automethod:: __str__
"""

def __init__(self, **kwargs):
Expand Down Expand Up @@ -477,8 +472,6 @@ def parse(self, resource):
class TextInventory(cts.TextInventory):

""" Represents a CTS Inventory file
.. automethod:: __str__
"""

def __init__(self, **kwargs):
Expand Down
1 change: 1 addition & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
:target: https://pypi.python.org/pypi/MyCapytain
.. image:: https://api.codacy.com/project/badge/grade/8e63e69a94274422865e4f275dbf08ea
:target: https://www.codacy.com/app/leponteineptique/MyCapytain

MyCapytain is a python package which provides a large set of tools to deal with CTS and Capitains Guidelines in Python.

Installation and Requirements
Expand Down

0 comments on commit 4dd3ba3

Please sign in to comment.