Method: FeatureMap::Private::TestPyramidFile.header_comment

Defined in:
lib/feature_map/private/test_pyramid_file.rb

.header_comment ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/feature_map/private/test_pyramid_file.rb', line 36

def self.header_comment
  <<~HEADER
    # STOP! - DO NOT EDIT THIS FILE MANUALLY
    # This file was automatically generated by "bin/featuremap test_pyramid". The next time this file
    # is generated any changes will be lost. For more details:
    # https://github.com/Beyond-Finance/feature_map
    #
    # It is NOT recommended to commit this file into your source control. It will change or become
    # outdated frequently. Instead it should be regenerated when test pyramid statistics are required.
    # This file should be ignored by your source control, allowing the local copy to be used for other
    # feature analysis operations (e.g. documentation generation, etc).
  HEADER
end