Add a few naming guidelines for the converter library.

PiperOrigin-RevId: 204199604
This commit is contained in:
Dan Moldovan 2018-07-11 15:21:24 -07:00 committed by TensorFlower Gardener
parent 3607217a7d
commit f2fa55c8d2

View File

@ -18,5 +18,15 @@ from __future__ import absolute_import
from __future__ import division from __future__ import division
from __future__ import print_function from __future__ import print_function
# TODO(mdan): Define a base transformer class that can recognize skip_processing # Naming conventions:
# TODO(mdan): All converters are incomplete, especially those that change blocks # * each converter should specialize on a single idiom; be consistent with
# the Python reference for naming
# * all converters inherit core.converter.Base
# * module names describe the idiom that the converter covers, plural
# * the converter class is named consistent with the module, singular and
# includes the word Transformer
#
# Example:
#
# lists.py
# class ListTransformer(converter.Base)