StardustXR / StardustXR/server
Autodocument vars/features
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 185
- Forks
- 25
- PR merge metrics
- No merged PRs in 30d
Description
When making additional envvars that control the program/code flow like https://github.com/StardustXR/server/commit/cac2be7a4fb4f1eea187322dc3aad291007e72bc it is important to consider that it is not automatically documenting itself or making itself known in anyway.
It might be possible to make a rust function that mandates a documentation string, and that could be printed in some way by the program, imagine stardust-xr-server --list-vars. The way --list-vars could be populated is by a function like stardustxr_make_feature which would take a documentation string and env var as arguments, therefore making it impossible to make an envvar lookup that doesn't document itself and make itself known within the code.
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
Start by reviewing the existing environment-variable lookups and the proposed stardustxr_make_feature entry point. Consider how a --list-vars command could expose each variable's documentation, then define the required interface and completion criteria before implementing it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- backend, cli
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100