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.

Sign up for GitHub

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

Jump to bottom

Documentation cleanup around sublibraries #8982

Merged
merged 1 commit into from
Jun 19, 2023
Merged

Documentation cleanup around sublibraries #8982

merged 1 commit into from
Jun 19, 2023

Conversation

chreekat
Copy link
Collaborator

The docs make it sound like sublibraries definitely aren't supported, and then go on to explain how to use them. I tried to catch all the cases where that happened.

I've added a couple FIXMEs about things I'm not sure about!

Bonus points for added automated tests!

chreekat
chreekat commented May 30, 2023
View reviewed changes
doc/cabal-package.rst Outdated Show resolved Hide resolved
ulysses4ever
ulysses4ever reviewed May 30, 2023
View reviewed changes
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.

Very cool, thank you! I'd be happy to approve when the fixme's are resolved.

doc/cabal-package.rst Show resolved Hide resolved
@chreekat
Copy link
Collaborator Author

chreekat commented May 31, 2023 •
edited
Loading

From my perspective this is now good enough to merge. It would be nice to add an example with multiple visible libraries, but it can wait.

@ulysses4ever
Copy link
Collaborator

Do you want to convert to a non-draft?

@chreekat chreekat marked this pull request as ready for review May 31, 2023 10:55
@chreekat
Copy link
Collaborator Author

Do you want to convert to a non-draft?

Oops, I hadn't actually used that feature on github before :)

@chreekat chreekat changed the title Draft some cleanup around sublibraries Documentation cleanup around sublibraries May 31, 2023
fgaz
fgaz approved these changes May 31, 2023
View reviewed changes
Copy link
Member

@fgaz fgaz left a comment

Choose a reason for hiding this comment

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

Thanks!

@fgaz
Copy link
Member

fgaz commented May 31, 2023

fyi you left "Draft" in the commit message, not sure if that's intended

@chreekat chreekat added the merge me Tell Mergify Bot to merge label May 31, 2023
@chreekat
Copy link
Collaborator Author

Ah, it was a bit of an unconscious choice (I was also "drafting" in the sense of writing prose), but I think a quick amendment wouldn't go awry.

@chreekat
Copy link
Collaborator Author

chreekat commented May 31, 2023 •
edited
Loading

Thanks for the reviews! I added merge-me so I think this is good to go now.

@chreekat chreekat closed this Jun 1, 2023
@chreekat chreekat deleted the wip/b/multilib-docs branch June 1, 2023 08:21
@chreekat
Copy link
Collaborator Author

chreekat commented Jun 1, 2023

Lol oops, deleted the branch too fast.

@chreekat chreekat restored the wip/b/multilib-docs branch June 1, 2023 08:22
@chreekat chreekat reopened this Jun 1, 2023
@ulysses4ever
Copy link
Collaborator

The bot will take it after the two-day delay that we setup as a measure that allows more people to look at it.

@chreekat
Copy link
Collaborator Author

chreekat commented Jun 1, 2023

I think I remember hearing about that. In this case, I was cleaning up branches on my laptop and kind of forgot that the PR hadn't actually been merged yet. :) Git doesn't care what GitHub is doing with branches...

@mergify mergify bot added the merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days label Jun 3, 2023
@ulysses4ever
Copy link
Collaborator

@mergify rebase

@chreekat @ulysses4ever
Clean up multilib documentation
870a4e5 
Or more accurately, clean up documentation of other sections that imply
multilib doesn't exist yet.
@mergify
Copy link
Contributor

mergify bot commented Jun 19, 2023

rebase

✅ Branch has been successfully rebased

@mergify mergify bot merged commit e1a10bd into haskell:master Jun 19, 2023
@chreekat chreekat deleted the wip/b/multilib-docs branch August 8, 2023 07:05
@lsmor lsmor mentioned this pull request Dec 8, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fgaz fgaz fgaz approved these changes

@ulysses4ever ulysses4ever ulysses4ever approved these changes

Assignees
No one assigned
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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@chreekat @ulysses4ever @fgaz