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

Scarb Doc: cross item linkage #1690

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

Scarb Doc: cross item linkage #1690

wants to merge 12 commits into from

Conversation

wawel37
Copy link
Contributor

@wawel37 wawel37 commented Oct 25, 2024

Waiting for this to be merged.

Cargo.toml Outdated Show resolved Hide resolved
@wawel37 wawel37 marked this pull request as ready for review November 5, 2024 14:23
@wawel37
Copy link
Contributor Author

wawel37 commented Nov 5, 2024

Waiting for this to be merged.

Review ready

@maciektr maciektr changed the title Doc/doc links Scarb Doc: cross item linkeage Nov 12, 2024
@maciektr maciektr changed the title Scarb Doc: cross item linkeage Scarb Doc: cross item linkage Nov 12, 2024
Copy link
Contributor

@maciektr maciektr left a comment

Choose a reason for hiding this comment

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

Not sure if it's only me or not, but passing this very specific included_items everywhere just bothers me a bit 😅 Maybe we can at least hide it behind some abstraction? Something like this is coming to my mind, probably not ideal though: https://gist.github.com/2028017ce043ca137530cd0281fdf55b.git
LMKWYT

extensions/scarb-doc/src/types.rs Outdated Show resolved Hide resolved
extensions/scarb-doc/src/types.rs Outdated Show resolved Hide resolved
@wawel37 wawel37 requested a review from a team as a code owner November 20, 2024 15:08
@wawel37
Copy link
Contributor Author

wawel37 commented Nov 22, 2024

Not sure if it's only me or not, but passing this very specific included_items everywhere just bothers me a bit 😅 Maybe we can at least hide it behind some abstraction? Something like this is coming to my mind, probably not ideal though: https://gist.github.com/2028017ce043ca137530cd0281fdf55b.git LMKWYT

I totally agree. Moved the included items to the context. Tbh I don't see any more elegant solve for this problem here, as we need to keep track of those included items throughout creating types and later generating docs. Maybe in the future we can make some refactor, which would keep the context in mind

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.

2 participants