Database.query methods share docstrings#13515
Merged
Conversation
scheibelp
reviewed
Oct 30, 2019
tgamblin
pushed a commit
that referenced
this pull request
Nov 1, 2019
Currently, query arguments in the Spack core are documented on the Database._query method, where the functionality is defined. For users of the spack python command, this makes the python builtin method help less than ideally useful, as help(spack.store.db.query) and help(spack.store.db.query_local) do not show relevant information. This PR updates the doc attributes for the Database.query and Database.query_local arguments to mirror everything after the first line of the Database._query docstring.
tldahlgren
added a commit
to tldahlgren/spack
that referenced
this pull request
Dec 10, 2019
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Currently, query arguments in the Spack core are documented on the
Database._querymethod, where the functionality is defined.For users of the
spack pythoncommand, this makes the python builtin methodhelpless than ideally useful, ashelp(spack.store.db.query)andhelp(spack.store.db.query_local)do not show relevant information.This PR updates the doc attributes for the
Database.queryandDatabase.query_localarguments to mirror everything after the first line of theDatabase._querydocstring.