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

Sync join and sync leave documentation #82

Merged
merged 3 commits into from
Apr 13, 2024

Conversation

jaczhi
Copy link
Contributor

@jaczhi jaczhi commented Apr 11, 2024

@jaczhi jaczhi marked this pull request as ready for review April 12, 2024 21:33
@jaczhi
Copy link
Contributor Author

jaczhi commented Apr 12, 2024

@tianyuan129 anything I should add? I know other protocol spec documentation is longer, but I'm not sure what specifically to explain.

@Pesa
Copy link
Contributor

Pesa commented Apr 12, 2024

Don't these new documents have to be referenced from the index or some other document? I believe sphinx raises a warning otherwise (and also, how does the reader discover their existence?)

@jaczhi
Copy link
Contributor Author

jaczhi commented Apr 12, 2024

Thanks Davide--you are completely correct. I have now linked them into specification.rst.

@tianyuan129 tianyuan129 self-assigned this Apr 12, 2024
@tianyuan129 tianyuan129 self-requested a review April 12, 2024 22:42
docs/src/specification/sync_join.rst Outdated Show resolved Hide resolved
docs/src/specification/sync_join.rst Outdated Show resolved Hide resolved
docs/src/specification/sync_leave.rst Show resolved Hide resolved
@jaczhi jaczhi requested a review from tianyuan129 April 12, 2024 23:43
@tianyuan129
Copy link
Contributor

I think it's good to go. Thank you so much for the effort!

@tianyuan129 tianyuan129 merged commit 62f9113 into UCLA-IRL:sync Apr 13, 2024
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