Skip to content

Update README#263

Merged
ChrisPulman merged 2 commits intomainfrom
UpdateReadMe
Jun 18, 2025
Merged

Update README#263
ChrisPulman merged 2 commits intomainfrom
UpdateReadMe

Conversation

@ChrisPulman
Copy link
Member

What kind of change does this PR introduce?

docs

What is the current behavior?

incorrect partial declaration in docs

What is the new behavior?

This pull request updates the README.md documentation for ReactiveUI Source Generators to improve usability and clarify usage examples. The most important changes include adding a detailed Table of Contents, modifying a property declaration to use the partial keyword, and clarifying naming conventions for generated commands.

Documentation Enhancements:

  • Added a comprehensive Table of Contents to improve navigation and accessibility in the README.md.

Code Example Updates:

  • Modified the MyProperty declaration to use the partial keyword, aligning with Source Generator requirements for enhanced functionality.
  • Clarified naming conventions for generated commands by noting the removal of the "Async" suffix in the relevant example.

What might this PR break?

None

Please check if the PR fulfills these requirements

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

Other information:

@ChrisPulman ChrisPulman merged commit 38f6494 into main Jun 18, 2025
1 check passed
@ChrisPulman ChrisPulman deleted the UpdateReadMe branch June 18, 2025 23:50
@github-actions
Copy link

github-actions bot commented Jul 3, 2025

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 3, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants