Skip to content

docs: Add docs of options for xxx_with APIs#4099

Merged
Xuanwo merged 2 commits intomainfrom
add-docs-for-public-api
Jan 30, 2024
Merged

docs: Add docs of options for xxx_with APIs#4099
Xuanwo merged 2 commits intomainfrom
add-docs-for-public-api

Conversation

@Xuanwo
Copy link
Copy Markdown
Member

@Xuanwo Xuanwo commented Jan 30, 2024

No description provided.

Signed-off-by: Xuanwo <github@xuanwo.io>
@github-actions github-actions bot added the releases-note/docs The PR modifies docs related content or has a title that begins with "docs" label Jan 30, 2024
Copy link
Copy Markdown
Member

@tisonkun tisonkun 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 guess some formatters/linters complain that is trivial to fix.

Copy link
Copy Markdown
Member

@suyanhanx suyanhanx left a comment

Choose a reason for hiding this comment

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

Thanks.
Some bindings need to rebuild.

Signed-off-by: Xuanwo <github@xuanwo.io>
@Xuanwo Xuanwo requested a review from xyjixyjixyji as a code owner January 30, 2024 10:26
@Xuanwo Xuanwo changed the title docs: Add options for xxx_with APIs docs: Add docs of options for xxx_with APIs Jan 30, 2024
@Xuanwo
Copy link
Copy Markdown
Member Author

Xuanwo commented Jan 30, 2024

LGTM. I guess some formatters/linters complain that is trivial to fix.

I hope we can stabilize format_code_in_doc_comments soon: rust-lang/rustfmt#3348

@tisonkun
Copy link
Copy Markdown
Member

@Xuanwo we can somehow use cargo +nightly fmt --check for checking.

@Xuanwo
Copy link
Copy Markdown
Member Author

Xuanwo commented Jan 30, 2024

we can somehow use cargo +nightly fmt --check for checking.

All contributors are required to use cargo +nightly fmt. I'm a bit hesitant about this, but it doesn't happen often (only before releasing).

I think we can incorporate it into the release process and include it in the bumping PR.

@Xuanwo Xuanwo merged commit 953d472 into main Jan 30, 2024
@Xuanwo Xuanwo deleted the add-docs-for-public-api branch January 30, 2024 10:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

releases-note/docs The PR modifies docs related content or has a title that begins with "docs"

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants