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

Doc/remove trivia from signatures #6393

Merged

Conversation

wawel37
Copy link
Contributor

@wawel37 wawel37 commented Sep 19, 2024

This change is Reviewable

Copy link
Member

@mkaput mkaput left a comment

Choose a reason for hiding this comment

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

Reviewed 1 of 4 files at r1.
Reviewable status: 0 of 8 files reviewed, 1 unresolved discussion (waiting on @Arcticae, @Draggu, @orizi, @piotmag769, and @wawel37)


crates/cairo-lang-doc/src/tests/test.rs line 230 at r1 (raw file):

    output.insert(
        "Item #".to_string() + &item_number.to_string(),
        format!("{}\n{}", signature, documentation.unwrap_or_default()),

can you submit signature and docs as separate sections, like Item signature #0 & Item documentation #0? This way it'd be much more readable when you're reading just the fixture

Copy link
Contributor Author

@wawel37 wawel37 left a comment

Choose a reason for hiding this comment

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

Reviewable status: 0 of 8 files reviewed, 1 unresolved discussion (waiting on @Arcticae, @Draggu, @mkaput, @orizi, and @piotmag769)


crates/cairo-lang-doc/src/tests/test.rs line 230 at r1 (raw file):

Previously, mkaput (Marek Kaput) wrote…

can you submit signature and docs as separate sections, like Item signature #0 & Item documentation #0? This way it'd be much more readable when you're reading just the fixture

Done.

@wawel37 wawel37 requested a review from mkaput September 30, 2024 09:56
Copy link
Member

@mkaput mkaput left a comment

Choose a reason for hiding this comment

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

:lgtm:

Reviewed 4 of 7 files at r2, 4 of 4 files at r3, all commit messages.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on @Arcticae, @Draggu, @orizi, and @piotmag769)

@piotmag769 piotmag769 added this pull request to the merge queue Oct 2, 2024
Merged via the queue into starkware-libs:main with commit 323ea7e Oct 2, 2024
44 checks passed
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.

3 participants