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

Correct formatting errors in Encodings.md #183

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

BMDan
Copy link

@BMDan BMDan commented Mar 24, 2022

In particular, address the issue that formatting caused the text after "The data stream looks like:" in "Delta-length byte array" to disappear entirely.

The remainder of changes are simply for consistency and readability.

Make sure you have checked all steps below.

Jira

Commits

  • My commits all reference Jira issues in their subject lines. In addition, my commits follow the guidelines from "How to write a good git commit message":
    1. Subject is separated from body by a blank line
    2. Subject is limited to 50 characters (not including Jira issue reference)
    3. Subject does not end with a period
    4. Subject uses the imperative mood ("add", not "adding")
    5. Body wraps at 72 characters
    6. Body explains "what" and "why", not "how"

Documentation

  • In case of new functionality, my PR adds documentation that describes how to use it.
    • All the public functions and the classes in the PR contain Javadoc that explain what it does

In particular, address the issue that formatting caused the text after "The data stream looks like:" in "Delta-length byte array" to disappear entirely.

The remainder of changes are simply for consistency and readability.
Remove remaining colons in category headers.  Ensure all encodings have anchors corresponding to their constant names.
@BMDan
Copy link
Author

BMDan commented May 2, 2022

Tagging @jincongho ; is it worth creating a Jira issue for this, or should I just close the PR?

@jincongho
Copy link
Contributor

@BMDan Go ahead to create a Jira issue; though I dont have permission to help you merge PR.

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.

None yet

2 participants