← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/_annotator_py.py

  • Committer: John Arbash Meinel
  • Date: 2009-07-08 15:28:05 UTC
  • mto: This revision was merged to the branch mainline in revision 4522.
  • Revision ID: john@arbash-meinel.com-20090708152805-nbgmogmzfbfbuu28
Some small tweaks, add more documentation for 'add_special_text'.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/_annotator_py.py
224
224
        self._record_annotation(key, parent_keys, annotations)
225
225
 
226
226
    def add_special_text(self, key, parent_keys, text):
227
 
        """Add a specific text to the graph."""
 
227
        """Add a specific text to the graph.
 
228
 
 
229
        This is used to add a text which is not otherwise present in the
 
230
        versioned file. (eg. a WorkingTree injecting 'current:' into the
 
231
        graph to annotate the edited content.)
 
232
 
 
233
        :param key: The key to use to request this text be annotated
 
234
        :param parent_keys: The parents of this text
 
235
        :param text: A string containing the content of the text
 
236
        """
228
237
        self._parent_map[key] = parent_keys
229
238
        self._text_cache[key] = osutils.split_lines(text)
230
239
        self._heads_provider = None