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

Merge cardano-api:internal with cardano-api main library under Cardano.Api.Internal.* and export required symbols #748

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

palas
Copy link
Contributor

@palas palas commented Feb 6, 2025

Changelog

- description: |
    Merged `cardano-api:internal` with `cardano-api` main library under `Cardano.Api.Internal.*` and expose requried symbols
  type:
  - refactoring    # QoL changes

Context

Links between different components of a project in Haddock do not seem to work. Documentation in #698 link documentation from modules in cardano-api with modules in cardano-api:internal. For that reason, this PR combines the internal component with the main library component.

How to trust this PR

Check no functionality was modified. Ensure the organisation of modules and re-exports makes sense.

I suggest considering the result of not applying the last commit (keeping the modules separated inside the Cardano.Api.Internal. Which may be clearer.

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • New tests are added if needed and existing tests are updated. See Running tests for more details
  • Self-reviewed the diff

@smelc
Copy link
Contributor

smelc commented Feb 7, 2025

I'm not the one who should approve, but I think this is a great change 👍

cardano-api/cardano-api.cabal Outdated Show resolved Hide resolved
cardano-api/cardano-api.cabal Show resolved Hide resolved
@carbolymer
Copy link
Contributor

Besides my other remarks, nice change!

@carbolymer
Copy link
Contributor

carbolymer commented Feb 7, 2025

Links between different components of a project in Haddock do not seem to work. Documentation in #698 link documentation from modules in cardano-api with modules in cardano-api:internal

What do you mean here? I'm able to jump between cardano-api modules just fine here: https://cardano-api.cardano.intersectmbo.org/ Can you provide examples? If linking is still broken, can you add the examples to #601 to not lose track of them

Copy link
Contributor

@Jimbo4350 Jimbo4350 left a comment

Choose a reason for hiding this comment

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

LGTM! I agree with @carbolymer's comments

cardano-api/cardano-api.cabal Show resolved Hide resolved
@palas palas force-pushed the merge-internal-lib branch from 56d7230 to 67d826e Compare February 7, 2025 15:34
@palas palas changed the title Merge cardano-api:internal with cardano-api main library and expose requried symbols through Cardano.Api.Internal module Merge cardano-api:internal with cardano-api main library under Cardano.Api.Internal.* and export required symbols Feb 7, 2025
@palas
Copy link
Contributor Author

palas commented Feb 7, 2025

What do you mean here? I'm able to jump between cardano-api modules just fine here: https://cardano-api.cardano.intersectmbo.org/ Can you provide examples? If linking is still broken, can you add the examples to #601 to not lose track of them

It is when you write a specific link to something in a comment, by using ", not when it is implied by the actual code. You can see the example here: https://github.com/IntersectMBO/cardano-api/pull/698/files#diff-a0184298d1665714978e4d3d3400bea78e52eb231211cefea8da26a0ed3cd4deR9

@palas palas requested a review from carbolymer February 7, 2025 15:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants