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

Crate docs for shared module #261

Merged

Conversation

josecelano
Copy link
Member

@josecelano josecelano commented Mar 24, 2023

Documentation for the crate::shared module.

  • bit_torrent mod.
  • clock mod.
  • crypto mod.

@josecelano josecelano force-pushed the issue-260-crate-docs-for-shared-mod branch from f07bbd5 to cf2dc4c Compare March 24, 2023 17:27
@josecelano josecelano added the Documentation Improves Instructions, Guides, and Notices label Mar 24, 2023
@josecelano josecelano linked an issue Mar 24, 2023 that may be closed by this pull request
@josecelano josecelano force-pushed the issue-260-crate-docs-for-shared-mod branch 3 times, most recently from 601b6d5 to 9391129 Compare March 28, 2023 09:39
@josecelano josecelano marked this pull request as ready for review March 28, 2023 09:42
@josecelano
Copy link
Member Author

Hi @da2ce7 @WarmBeer , this is ready to review.

@josecelano josecelano force-pushed the issue-260-crate-docs-for-shared-mod branch from 9391129 to 0bf13e6 Compare March 28, 2023 10:29
Copy link
Contributor

@da2ce7 da2ce7 left a comment

Choose a reason for hiding this comment

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

Hello jose, you may wish to rebase upon: 8746d82
And apply the changes in this fixup: df0a9ee

Otherwise really good docs! :)

@da2ce7
Copy link
Contributor

da2ce7 commented Mar 28, 2023

df0a9ee can be squashed into 0bf13e6, it adds nothing of value as a interdependent comment.

@josecelano
Copy link
Member Author

Hello jose, you may wish to rebase upon: 8746d82 And apply the changes in this fixup: df0a9ee

Otherwise really good docs! :)

Thank you, @da2ce7. I've included your commits! Thank you for fixing the comment about the "The year 2038 problem". I searched for the i64 overflow without reading the whole article. My comment was a bit inaccurate. From 15 years (2038 - 20233) to 21 times the universe's estimated age of the universe 🤣.

Many modern systems have been upgraded to measure Unix time with signed 64-bit integers which will not overflow for 292 billion years, which is approximately 21 times the estimated age of the universe.

Source: https://en.wikipedia.org/wiki/Year_2038_problem

@josecelano josecelano force-pushed the issue-260-crate-docs-for-shared-mod branch from df0a9ee to ddf4dc6 Compare March 28, 2023 15:39
@josecelano
Copy link
Member Author

ACK ddf4dc6

@josecelano
Copy link
Member Author

df0a9ee can be squashed into 0bf13e6, it adds nothing of value as a interdependent comment.

Done.

@josecelano josecelano merged commit 31742c4 into torrust:develop Mar 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improves Instructions, Guides, and Notices
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

crate docs: for sharedmod
2 participants