clockworklabs / clockworklabs/SpacetimeDB
Docs - Use consistent keywords for the `Module` class in C# code examples
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 25.2k
- Forks
- 1.1k
- Avg merge
- 2d 7h
- Merged PRs (30d)
- 46
Description
Various C# module code examples in our Docs use different sets of keywords to define the Module class that holds all the module code. Apparently the RLS reference uses public partial class, and the C# reference has both static partial class and public static partial class.
Pick one set of keywords, put it in the style guide, then grep the docs for class Module and make every occurrence use exactly that set of keywords.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the existing C# module examples and the documentation style guide to compare the keyword variants. Use grep for class Module across the docs, choose one consistent form, document that choice in the style guide, and update every matching occurrence.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 62/100