charmbracelet / charmbracelet/x

godoc(term): unclear what `fd.utptr` is

Open
#76 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Go
Stars
314
Forks
94
Avg merge
3d 22h
Merged PRs (30d)
2

Description

We should definitely include some common file descriptors for terminal apps, given that's the most likely usage. Maybe even link to other kinds of file descriptors. Fwiw I'm using with the `term.GetSize()` func

Contributor guide

Open the contributing guide

Research direction

Start with the godoc for fd.utptr and the term.GetSize entry point to determine which terminal file descriptors the documentation currently explains. Done means the godoc clearly identifies common terminal descriptors and links to relevant other file-descriptor types.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.