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

Reassociate .NET README note on parameter type name #277

Merged
merged 1 commit into from
Feb 15, 2024

Conversation

kieran-ryan
Copy link
Member

@kieran-ryan kieran-ryan commented Feb 12, 2024

🤔 What's changed?

⚡️ What's your motivation?

Text was originally added as additional documentation for the .NET implementation.

When Python support was added (#65), the Python README example was added between the .NET code example and the .NET footnote.

This creates a source of confusion, as it now appears associated with the Python example - which is incorrect.

🏷️ What kind of change is this?

  • 🏦 Refactoring/debt/DX (improvement to code design, tooling, documentation etc. without changing behaviour)

♻️ Anything particular you want feedback on?

  • Whether this is globally applicable? i.e. that "custom parameters can only be used with the type name" e.g. Color for .NET, color for Python, etc.
    • If so, whether note should be made generic and moved to global scope - rather than only a specific language implementation?

📋 Checklist:

@mpkorstanje mpkorstanje merged commit 8719afe into main Feb 15, 2024
26 checks passed
@mpkorstanje mpkorstanje deleted the fix-dotnet-readme-docs branch February 15, 2024 19:50
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.

2 participants