fix: Update README.md to correct "Foreign Functions" chapter number to 23 (Issue #20) #33
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Description
Summary
This pull request addresses a documentation error identified in Issue #20. Specifically, it aims to correct the heading "Chapter 22: Foreign Functions" in the
README.mdfile to properly reflect the correct chapter number as per the second edition of the book. The correct heading should read "Chapter 23: Foreign Functions".Background
In reviewing the documentation for the book, it was noted that the "Foreign Functions" chapter was mistakenly listed as Chapter 22. This inconsistency arises from the fact that in the first edition of the book, there was no chapter dedicated to "Foreign Functions." However, with the release of the second edition, this topic is now included as Chapter 23.
Changes Made
README.mdfile from:Rationale
Correcting this heading is essential to ensure that users and readers of the documentation have accurate information regarding the structure of the book, especially when transitioning from the first edition to the second edition. This small but significant change will help in avoiding confusion among readers regarding the chapters and their respective contents.
Additional Notes
This change is purely a documentation update and does not affect any code or functionality within the project. No additional tests are necessary as this change pertains solely to text correction.
Next Steps
If approved, this pull request will ensure that the documentation reflects the correct chaptering of the book, improving the overall clarity for users. Please review the changes and merge at your earliest convenience.
Thank you for your attention to this matter.