Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

index Paths and Paths_ (resp. for PackageInfo) #10267

Merged
merged 1 commit into from
Aug 22, 2024

Conversation

geekosaur
Copy link
Collaborator

@geekosaur geekosaur commented Aug 20, 2024

These can currently be found by searching the documentation for Paths_pkgname and PackageInfo_pkgname, but you pretty much need to know that to begin with to find them. Add Sphinx index entries to make them more discoverable.

Fixes: #10233

Template B: This PR does not modify behaviour or interface

E.g. the PR only touches documentation or tests, does refactorings, etc.

Include the following checklist in your PR:

  • Patches conform to the coding conventions.
  • Is this a PR that fixes CI? If so, it will need to be backported to older cabal release branches (ask maintainers for directions).

Copy link
Collaborator

@ulysses4ever ulysses4ever left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Terrific!

Copy link
Member

@Kleidukos Kleidukos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fantastic

@geekosaur geekosaur marked this pull request as ready for review August 20, 2024 23:33
@mpickering
Copy link
Collaborator

Great patch.

@mergify mergify bot added the merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days label Aug 22, 2024
These can currently be found by searching the documentation for
`Paths_pkgname` and `PackageInfo_pkgname`, but you pretty much
need to know that to begin with to find them. Add Sphinx index
entries to make them more discoverable.
@mergify mergify bot merged commit 7154f84 into haskell:master Aug 22, 2024
14 checks passed
@geekosaur
Copy link
Collaborator Author

@mergify backport 3.12

Copy link
Contributor

mergify bot commented Aug 30, 2024

backport 3.12

✅ Backports have been created

@geekosaur geekosaur deleted the index-autogens branch August 30, 2024 21:13
mergify bot added a commit that referenced this pull request Aug 30, 2024
index Paths and Paths_ (resp. for PackageInfo) (backport #10267)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days merge me Tell Mergify Bot to merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Search does not Reveal Docs for Paths_{pkgname}
4 participants