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 formatting of Algorithm.md and python/README.md #96

Merged
merged 4 commits into from
May 2, 2024
Merged

Improve formatting of Algorithm.md and python/README.md #96

merged 4 commits into from
May 2, 2024
+113 −86

Conversation

azriel1rf
Copy link
Collaborator

@azriel1rf azriel1rf commented May 2, 2024 •
edited
Loading

This pull request improves the formatting and readability of the Algorithm.md and python/README.md. The document was formatted by markdownlint and then manually fixed.

Changes include:

  • Fix indentation of code blocks
  • Use ```text for plain text code blocks rather than just ```.
  • Add blank lines before ## headers for proper Markdown formatting
  • Use escaping for * characters that should be literal asterisks
  • Fix a few minor typos and formatting issues

These changes are compatible with future markdown linter standards in this repo. (#95)

@azriel1rf
Move CardSampler to separate files and use it in evaluation tests (#91
9157517 
)

* Refactor card_sampler include paths in benchmark files

* Refactor to use `card_sampler::CardSampler` in tests

* Refactor card_sampler implementation to separate header and source files
@azriel1rf
Format Algorithm.md
167e788
@azriel1rf azriel1rf requested a review from HenryRLee May 2, 2024 20:36
@azriel1rf azriel1rf self-assigned this May 2, 2024
@azriel1rf azriel1rf changed the title Improve formatting and readability of Algorithm.md Improve formatting of Algorithm.md and python/README.md May 2, 2024
@azriel1rf azriel1rf mentioned this pull request May 2, 2024
Merged
HenryRLee
HenryRLee approved these changes May 2, 2024
View reviewed changes
Copy link
Owner

@HenryRLee HenryRLee left a comment

Choose a reason for hiding this comment

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

Very nice! Thanks!

@HenryRLee HenryRLee merged commit 18af554 into develop May 2, 2024
6 checks passed
@azriel1rf azriel1rf deleted the format_markdown branch May 2, 2024 22:54
@azriel1rf azriel1rf restored the format_markdown branch May 2, 2024 22:56
@azriel1rf azriel1rf deleted the format_markdown branch May 2, 2024 22:56
azriel1rf added a commit that referenced this pull request May 2, 2024
@azriel1rf
Improve formatting of Algorithm.md and python/README.md (#96)
726edf9 
* Format Algorithm.md

* fix README.md
azriel1rf added a commit that referenced this pull request May 4, 2024
@azriel1rf
Improve formatting of Algorithm.md and python/README.md (#96)
c239bb0 
* Format Algorithm.md

* fix README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@HenryRLee HenryRLee HenryRLee approved these changes

Assignees

@azriel1rf azriel1rf

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@azriel1rf @HenryRLee