spectreconsole / spectreconsole/website
Web docs/reference material includes unreleased features
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 5
- Forks
- 7
- PR merge metrics
- No merged PRs in 30d
Description
Information
- OS: Windows
- Version: 0.48.0
- Terminal: Windows Terminal
Describe the bug
Documentation on https://spectreconsole.net/ includes functionality that has not been shipped.
To Reproduce
- Install the latest version of Spectre.Console (0.48.0)
- Attempt to use the following documented functionality: https://spectreconsole.net/api/spectre.console/selectionpromptextensions/940dbecf
- Observe that the functionality does not exist in the current latest release
Expected behavior
Released documentation should match the behaviour of the latest released version, or have some appropriate versioning annotation for upcoming features.
Additional information
This function is also referenced in some examples, like the example under the heading "Choices" here: https://spectreconsole.net/prompts/text
Please upvote 👍 this issue if you are interested in it.
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 with the SelectionPromptExtensions API page and the “Choices” example at the prompts/text URL, comparing both with the released 0.48.0 behavior. Update the website so unreleased functionality is removed or clearly versioned, and verify the affected documentation matches the latest released version.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100