spack / spack/spack

Cannot find Python function `resource` in documentation

Open
#3,473 7 comments 0 reactions 1 assignee View on GitHub

@scheibelp is already working on this.

Since Apr 27, 2017.

documentation pinned resources
Dominant language
Python
Stars
5.1k
Forks
2.5k
Avg merge
3d 4h
Merged PRs (30d)
82

Description

I am trying to add a resource call to a package. I need to know which keywords arguments it expects. I currently cannot find this in the documentation.

I notice two problems:

  • When I follow a link in a search result, I end up at the top of a very large page, where I have to search again. I expect to be placed near the term which I searched.
  • The two pages spack package and Packaging Guide both describe what I'm probably looking for, but they list different and incomplete keyword arguments. They also don't explain the meaning of the keyword arguments well.
  • The notion of a FetchStrategy seems to be important to understanding resources. This term should again be a hyperlink in the API reference, so that I can look up what it means.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.