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

Improve top level crate documentation #985

Merged
merged 1 commit into from
Jul 2, 2023
Merged

Improve top level crate documentation #985

merged 1 commit into from
Jul 2, 2023

Conversation

n1ghtmare
Copy link
Collaborator

Added and rephrased some documentation.

@n1ghtmare n1ghtmare self-assigned this Jun 2, 2023
@n1ghtmare n1ghtmare force-pushed the n1ghtmare/docs-lib branch 2 times, most recently from a8ad93b to 15a85b3 Compare June 2, 2023 17:30
@caspervonb caspervonb changed the title Improve documentation for lib.rs Improve top level crate documentation Jun 2, 2023
Jarema
Jarema requested changes Jun 2, 2023
View reviewed changes
Copy link
Member

@Jarema Jarema left a comment

Choose a reason for hiding this comment

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

one small change request.

async-nats/src/lib.rs Outdated Show resolved Hide resolved
@n1ghtmare n1ghtmare force-pushed the n1ghtmare/docs-lib branch 3 times, most recently from 6a92627 to 2a39041 Compare June 2, 2023 17:53
@n1ghtmare n1ghtmare requested a review from Jarema June 2, 2023 18:15
caspervonb
caspervonb requested changes Jun 2, 2023
View reviewed changes
async-nats/src/lib.rs Outdated Show resolved Hide resolved
@n1ghtmare n1ghtmare requested a review from caspervonb June 5, 2023 11:44
Jarema
Jarema requested changes Jun 12, 2023
View reviewed changes
Copy link
Member

@Jarema Jarema left a comment

Choose a reason for hiding this comment

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

Some nits.

async-nats/src/lib.rs Outdated Show resolved Hide resolved
async-nats/src/lib.rs Outdated Show resolved Hide resolved
@n1ghtmare n1ghtmare requested a review from Jarema June 13, 2023 13:17
Jarema
Jarema requested changes Jun 30, 2023
View reviewed changes
Copy link
Member

@Jarema Jarema left a comment

Choose a reason for hiding this comment

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

It does not pass the spelling test.

@n1ghtmare n1ghtmare force-pushed the n1ghtmare/docs-lib branch 2 times, most recently from fb72e74 to 8d494ce Compare June 30, 2023 13:41
Jarema
Jarema requested changes Jul 1, 2023
View reviewed changes
Copy link
Member

@Jarema Jarema left a comment

Choose a reason for hiding this comment

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

doc test deadlocks.

async-nats/src/lib.rs Outdated Show resolved Hide resolved
Jarema
Jarema approved these changes Jul 1, 2023
View reviewed changes
Copy link
Member

@Jarema Jarema left a comment

Choose a reason for hiding this comment

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

LGTM

@Jarema Jarema merged commit cf2be59 into nats-io:main Jul 2, 2023
@n1ghtmare n1ghtmare deleted the n1ghtmare/docs-lib branch July 2, 2023 19:46
@Jarema Jarema mentioned this pull request Jul 13, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@caspervonb caspervonb caspervonb approved these changes

@Jarema Jarema Jarema approved these changes

Assignees

@n1ghtmare n1ghtmare

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@n1ghtmare @caspervonb @Jarema