Doc reviews #23
Closed
Doc reviews #23
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
…ub.io into feature/docsmigration
…ub.io into feature/docsmigration
…ub.io into feature/docsmigration
Updated the `HowTo_ChangePitchAndVolume.md` file to enhance readability and clarity of the code and instructions. Changes include bold formatting for method and class names, added explanations for pitch and volume concepts, `using` statements, fields for sound effect and its properties, and modifications to the `Game.LoadContent` method. Also included notes on sound looping, state checking, and usage of `MathHelper.Clamp` method. Extended example added for key press detection and sound effect adjustment. Updated the copyright year to 2024. The subproject commit in MonoGame has been updated to `81ed391a4d0fd81e3ee4bfe2492ad9a0e7f4cfc5`.
Updated the heading "An extended example" to "An Extended Example" for improved readability and consistency in capitalization. Added a new method "IsKeyPressed" under the "Game.Draw" method to check if a specified key is pressed, returning a boolean value.
…ub.io into documentation-reviews
…ub.io into documentation-reviews
…ub.io into feature/docsmigration
…e7777/docs.monogame.github.io into documentation-reviews
…ect commit Updated the `.gitignore` file to include the `/external/MonoGame` directory. Enhanced the `HowTo_ChangePitchAndVolume.md` file with updated instructions for playing a sound and adjusting its pitch and volume, including a new method `IsKeyPressed(Keys key)`. Added code in the `Game.Update` method to adjust the pitch and volume of the sound effect when the **Space** key is pressed. The pitch and volume values are increased by +0.1f each time the **Space key** is pressed and are clamped to ensure they are within valid ranges. Added notes explaining the use of the `MathHelper.Clamp` method and the potential issue of the keypress check not preventing the method from repeating. Updated the copyright year in the `HowTo_ChangePitchAndVolume.md` file from 2023 to 2024. Removed a subproject commit in the MonoGame project.
This commit primarily focuses on enhancing code readability and providing more detailed documentation. Key changes include the use of bold formatting for key terms and method names, addition of explanatory notes and tips, inclusion of using statements and field declarations at the top of the file/class, and a new method to check key press status. A caution note about file name and location usage, a note about sound status, and an extended example for pitch and volume adjustment have also been added. Comments have been inserted in the code for better understanding of certain operations. Lastly, some method names have been replaced with their bold counterparts for consistency and readability.
…iews Updated Pull request targetting [Base]
Body: Corrected a typographical error in the documentation. Changed "singe" to "single" in the sentence explaining how to prevent method repetition due to a keypress.
|
Duplicate |
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.
Corrected a typo.