zhangyiss/spack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

config.py: fixed comments that refer to variables following them (#6585)

Browse Source 
According to the documentation here:

  http://www.sphinx-doc.org/en/stable/ext/autodoc.html

"For module data members and class attributes, documentation can either
be put into a comment with special formatting (using a #: to start the
comment instead of just #), or in a docstring after the definition."
This commit is contained in:
Massimiliano Culpo 2017-12-07 08:09:53 +01:00 committed by GitHub
parent 3a4329c77d
commit 05b10ce967
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
lib/spack/spack/config.py
View File

@ -74,7 +74,7 @@
import spack.util.spack_yaml as syaml import spack.util.spack_yaml as syaml
"""Dict from section names -> schema for that section.""" #: Dict from section names -> schema for that section
section_schemas = { section_schemas = {
'compilers': spack.schema.compilers.schema, 'compilers': spack.schema.compilers.schema,
'mirrors': spack.schema.mirrors.schema, 'mirrors': spack.schema.mirrors.schema,
@ -84,9 +84,8 @@
'config': spack.schema.config.schema, 'config': spack.schema.config.schema,
} }
"""OrderedDict of config scopes keyed by name. #: OrderedDict of config scopes keyed by name.
Later scopes will override earlier scopes. #: Later scopes will override earlier scopes.
"""
config_scopes = OrderedDict() config_scopes = OrderedDict()
@ -211,25 +210,25 @@ def __repr__(self):
# #
_platform = spack.architecture.platform().name _platform = spack.architecture.platform().name
"""Default configuration scope is the lowest-level scope. These are #: Default configuration scope is the lowest-level scope. These are
versioned with Spack and can be overridden by systems, sites or users.""" #: versioned with Spack and can be overridden by systems, sites or users.
_defaults_path = os.path.join(spack.etc_path, 'spack', 'defaults') _defaults_path = os.path.join(spack.etc_path, 'spack', 'defaults')
ConfigScope('defaults', _defaults_path) ConfigScope('defaults', _defaults_path)
ConfigScope('defaults/%s' % _platform, os.path.join(_defaults_path, _platform)) ConfigScope('defaults/%s' % _platform, os.path.join(_defaults_path, _platform))
"""System configuration is per machine. #: System configuration is per machine.
No system-level configs should be checked into spack by default""" #: No system-level configs should be checked into spack by default
_system_path = os.path.join(spack.system_etc_path, 'spack') _system_path = os.path.join(spack.system_etc_path, 'spack')
ConfigScope('system', _system_path) ConfigScope('system', _system_path)
ConfigScope('system/%s' % _platform, os.path.join(_system_path, _platform)) ConfigScope('system/%s' % _platform, os.path.join(_system_path, _platform))
"""Site configuration is per spack instance, for sites or projects. #: Site configuration is per spack instance, for sites or projects.
No site-level configs should be checked into spack by default.""" #: No site-level configs should be checked into spack by default.
_site_path = os.path.join(spack.etc_path, 'spack') _site_path = os.path.join(spack.etc_path, 'spack')
ConfigScope('site', _site_path) ConfigScope('site', _site_path)
ConfigScope('site/%s' % _platform, os.path.join(_site_path, _platform)) ConfigScope('site/%s' % _platform, os.path.join(_site_path, _platform))
"""User configuration can override both spack defaults and site config.""" #: User configuration can override both spack defaults and site config.
_user_path = spack.user_config_path _user_path = spack.user_config_path
ConfigScope('user', _user_path) ConfigScope('user', _user_path)
ConfigScope('user/%s' % _platform, os.path.join(_user_path, _platform)) ConfigScope('user/%s' % _platform, os.path.join(_user_path, _platform))