Added docstring

Former-commit-id: e5cb45f

Author: reidmcy

metaknowledge/recordCollection.py

@@ -474,6 +474,30 @@ def makeDict(self, onlyTheseTags = None, longNames = False, cleanedVal = True, n
     def coAuthNetwork(self, detailedInfo = False, weighted = True, dropNonJournals = False, count = True):
         """Creates a coauthorship network for the RecordCollection.
 
+        # Parameters
+
+        _detailedInfo_ : `optional [bool or iterable[WOS tag Strings]]`
+
+        > default `False`, if `True` all nodes will be given info strings composed of information from the Record objects themselves. This is Equivalent to passing the list: `['PY', 'TI', 'SO', 'VL', 'BP']`.
+
+        > If _detailedCore_ is an iterable (That evaluates to `True`) of WOS Tags (or long names) The values  of those tags will be used to make the info attributes. All
+
+        > For each of the selected tags an attribute will be added to the node using the values of those tags on the first `Record` encountered. **Warning** iterating over `RecordCollection` objects is not deterministic the first `Record` will not always be same between runs. The node will be given attributes with the names of the WOS tags for each of the selected tags. The attributes will contain strings of containing the values (with commas removed), if multiple values are encountered they will be comma separated.
+
+        > Note: _detailedInfo_ is not identical to the _detailedCore_ argument of [`Recordcollection.coCiteNetwork()`](#RecordCollection.coCiteNetwork) or [`Recordcollection.citationNetwork()'](#RecordCollection.citationNetwork)
+
+        _weighted_ : `optional [bool]`
+
+        > default `True`, wether the edges are weighted. If `True` the edges are weighted by the number of co-authorships.
+
+        _dropNonJournals_ : `optional [bool]`
+
+        > default `False`, wether to drop authors from non-journals
+
+        _count_ : `optional [bool]`
+
+        > default `True`, causes the number of occurrences of a node to be counted
+
         # Returns
 
         `Networkx Graph`
@@ -497,7 +521,11 @@ def coAuthNetwork(self, detailedInfo = False, weighted = True, dropNonJournals =
             def attributeMaker(Rec):
                 attribsDict = {}
                 for val in infoVals:
-                    attribsDict[val] = str(getattr(Rec, val))
+                    recVal = getattr(Rec, val)
+                    if isinstance(recVal, list):
+                        attribsDict[val] = ', '.join((str(v).replace(',', '') , recVal))
+                    else:
+                        attribsDict[val] = str(recVal).replace(',', '')
                 if count:
                     attribsDict['count'] = 1
                 return attribsDict
@@ -589,6 +617,8 @@ def coCiteNetwork(self, dropAnon = True, nodeType = "full", nodeInfo = True, ful
 
         > The resultant string is the values of each tag, with commas removed, seperated by `', '`, just like the info given by non-core Citations. Note that for tags like `'AF'` that return lists only the first entry in the list will be used. Also a second attribute is created for all nodes called inCore wich is a boolean describing if the node is in the core or not.
 
+        > Note: _detailedCore_  is not identical to the _detailedInfo_ argument of [`Recordcollection.coAuthNetwork()`](#RecordCollection.coAuthNetwork)
+
         _coreOnly_ : `optional [bool]`
 
         > default `False`, if `True` only Citations from the RecordCollection will be included in the network
@@ -689,6 +719,8 @@ def citationNetwork(self, dropAnon = True, nodeType = "full", nodeInfo = True, f
 
         > The resultant string is the values of each tag, with commas removed, seperated by `', '`, just like the info given by non-core Citations. Note that for tags like `'AF'` that return lists only the first entry in the list will be used. Also a second attribute is created for all nodes called inCore wich is a boolean describing if the node is in the core or not.
 
+        > Note: _detailedCore_  is not identical to the _detailedInfo_ argument of [`Recordcollection.coAuthNetwork()`](#RecordCollection.coAuthNetwork)
+
         _coreOnly_ : `optional [bool]`
 
         > default `False`, if `True` only Citations from the RecordCollection will be included in the network