review/messages.py @ 8cea29aa955f

Add more documentation to the API.
author Steve Losh <steve@stevelosh.com>
date Thu, 08 Oct 2009 17:52:54 -0400
parents ab4cc556087d
children 9df20fad6514
#!/usr/bin/env python

INIT_START = '''\
initializing the code review data store and config
'''

INIT_SUCCESS = '''\
the review data has been initialized
run "hg commit .hgreview -m'initialize code review'" to record it permanently
'''

INIT_EXISTS_COMMITTED = '''\
the review data was already initialized by someone else
'''

INIT_EXISTS_UNCOMMITTED = '''\
the review data has already been initialized, but is not recorded!
run "hg commit .hgreview -m'initialize code review'" to record it permanently
'''

COMMENT_REQUIRES_MESSAGE = '''\
a message must be provided to add a comment!
'''

COMMENT_FILE_DOES_NOT_EXIST = '''\
file %s was not changed in revision %s!
'''

COMMENT_LINES_REQUIRE_FILE = '''\
you must give a filename to comment on specific lines!
'''

SIGNOFF_REQUIRES_MESSAGE = '''\
a message must be provided to sign off!
'''

SIGNOFF_OPINION_CONFLICT = '''\
cannot sign off as both --yes and --no!
'''

SIGNOFF_EXISTS = '''\
you have already signed off on this changeset (use --force to overwrite)!
'''

REVIEW_LOG_CSET = '''\
changeset: %d:%s
'''

REVIEW_LOG_AUTHOR = '''\
author:    %s
'''

REVIEW_LOG_SUMMARY = '''\
summary:   %s

'''

REVIEW_LOG_SIGNOFFS = '''\
signoffs:  %d signoffs (%d yes, %d no, %d neutral)
'''

REVIEW_LOG_COMMENTS = '''\
comments:  %d comments from %d authors
'''

REVIEW_LOG_FILE_HEADER = '''changes in %s'''

REVIEW_LOG_COMMENT_AUTHOR = '''\
# %s said:
'''

REVIEW_LOG_COMMENT_LINE = '''\
#     %s
'''

COMMIT_COMMENT = '''Add a comment on changeset %s'''
COMMIT_SIGNOFF = '''Sign off on changeset %s'''
DELETE_SIGNOFF = '''Remove sign off on changeset %s'''