[byteorder] Note that network-endian is a synonym for big-endian

[joshlf]

Closes #2033

[gemini-code-assist]

Summary of Changes

Hello @joshlf, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request provides a small but significant documentation update to the byteorder module. It clarifies a common point of confusion by explicitly stating that "network-endian" is synonymous with "big-endian," enhancing the module's readability and user understanding without altering any functional code.

Highlights

• Documentation Clarification: A note has been added to the src/byteorder.rs module-level documentation to explicitly state that network-endian is a synonym for big-endian.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request adds a helpful note to the byteorder module documentation, clarifying that network-endian is a synonym for big-endian. The change is correct and improves the documentation. I have one minor suggestion to make the note more precise by linking to the specific type aliases, which is more idiomatic for rustdoc.

[gemini-code-assist]

This is a good clarification. To be more precise and consistent with rustdoc conventions, you could link to the specific types, NetworkEndian and BigEndian, instead of using plain text. This makes it clear that this is a property of the types defined in this crate.

Suggested change

	//! Note that network-endian is a synonym for big-endian.
	//! Note that [`NetworkEndian`] is a synonym for [`BigEndian`].

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.14%. Comparing base (7b1260f) to head (6219825).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2785   +/-   ##
=======================================
  Coverage   88.14%   88.14%           
=======================================
  Files          20       20           
  Lines        5450     5450           
=======================================
  Hits         4804     4804           
  Misses        646      646           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.