Skip to content

docs: use xrefs to spack.package where possible & improve multi-valued variants section#51079

Merged
tgamblin merged 3 commits intodevelopfrom
hs/docs/fix-references
Jul 31, 2025
Merged

docs: use xrefs to spack.package where possible & improve multi-valued variants section#51079
tgamblin merged 3 commits intodevelopfrom
hs/docs/fix-references

Conversation

@haampie
Copy link
Copy Markdown
Member

@haampie haampie commented Jul 30, 2025

The packaging guide should always refer to spack.package when possible, to prevent people from importing private Spack API.

The only thing that is indirectly exposed from internals is the class DisjointSetsOfValues. I don't think that's terrible, just that we have to keep in mind that this is effectively also public API...

@haampie haampie force-pushed the hs/docs/fix-references branch from 58b8b3a to 72c9e5b Compare July 30, 2025 20:40
@haampie haampie force-pushed the hs/docs/fix-references branch from 72c9e5b to a4b0149 Compare July 30, 2025 20:41
@haampie haampie added this to the v1.1.0 milestone Jul 30, 2025
@haampie haampie added the v1.0.1 PRs to backport for v1.0.1 label Jul 30, 2025
haampie added 2 commits July 30, 2025 22:58
Signed-off-by: Harmen Stoppels <[email protected]>
@haampie haampie force-pushed the hs/docs/fix-references branch from 09bf5c5 to 8de3243 Compare July 31, 2025 08:06
@haampie haampie changed the title docs: fix reference spack.directives -> spack.package, and rewords mv variants docs: use xrefs to spack.package where possible & improve multi-valued variants section Jul 31, 2025
@tgamblin tgamblin merged commit 086e33e into develop Jul 31, 2025
33 checks passed
@tgamblin tgamblin deleted the hs/docs/fix-references branch July 31, 2025 09:24
haampie added a commit that referenced this pull request Jul 31, 2025
…ued variants section (#51079)

The packaging guide should always refer to `spack.package` when possible, to prevent
people from importing private Spack API.

The only thing that is indirectly exposed from internals is the class `DisjointSetsOfValues`.
I don't think that's terrible, just that we have to keep in mind that this is effectively also
public API...

* docs: fix reference spack.directives -> spack.package, and rewords mv variants
* Ensure all xrefs point to spack.package in packaging_*.rst

---------

Signed-off-by: Harmen Stoppels <[email protected]>
@haampie haampie mentioned this pull request Jul 31, 2025
29 tasks
alecbcs pushed a commit that referenced this pull request Aug 12, 2025
…ued variants section (#51079)

The packaging guide should always refer to `spack.package` when possible, to prevent
people from importing private Spack API.

The only thing that is indirectly exposed from internals is the class `DisjointSetsOfValues`.
I don't think that's terrible, just that we have to keep in mind that this is effectively also
public API...

* docs: fix reference spack.directives -> spack.package, and rewords mv variants
* Ensure all xrefs point to spack.package in packaging_*.rst

---------

Signed-off-by: Harmen Stoppels <[email protected]>
alstar555 pushed a commit to alstar555/spack that referenced this pull request Aug 27, 2025
…ued variants section (spack#51079)

The packaging guide should always refer to `spack.package` when possible, to prevent
people from importing private Spack API.

The only thing that is indirectly exposed from internals is the class `DisjointSetsOfValues`.
I don't think that's terrible, just that we have to keep in mind that this is effectively also
public API...

* docs: fix reference spack.directives -> spack.package, and rewords mv variants
* Ensure all xrefs point to spack.package in packaging_*.rst

---------

Signed-off-by: Harmen Stoppels <[email protected]>
Signed-off-by: Angelica Loshak <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

v1.0.1 PRs to backport for v1.0.1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants