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

Add type signature and documentation to toSavedConfig #10413

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add type signature and documentation to toSavedConfig #10413

wants to merge 1 commit into from

Conversation

9999years
Copy link
Collaborator

This helper function was challenging to understand, so I added an explicit type signature and documentation comments to it.

  • 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).

@9999years
Add type and documentation to toSavedConfig
6764661 
This helper function was challenging to understand, so I added
an explicit type signature and documentation comments to it.
@9999years 9999years changed the title Add type and documentation to toSavedConfig Add type signature and documentation to toSavedConfig Oct 2, 2024
9999years
9999years commented Oct 2, 2024
View reviewed changes
cabal-install/src/Distribution/Client/Config.hs
@@ -1314,6 +1315,19 @@ configFieldDescriptions src =
ParseArgs
]
where
toSavedConfig
:: (FieldDescr a -> FieldDescr SavedConfig)
-- Lifting function.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

NB: This function isn't rendered in Haddocks so these comments can't be Haddock comments.

@9999years 9999years added the merge me Tell Mergify Bot to merge label Oct 2, 2024
@mergify mergify bot added the ready and waiting Mergify is waiting out the cooldown period label Oct 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@geekosaur geekosaur geekosaur approved these changes

@ffaf1 ffaf1 ffaf1 approved these changes

Assignees
No one assigned
Labels
merge me Tell Mergify Bot to merge ready and waiting Mergify is waiting out the cooldown period
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@9999years @geekosaur @ffaf1