Deprecation as new section in coding standard
Open
Nobody has claimed this yet.
assigned
core
documentation
enhancement
priority-normal
- Dominant language
- Python
- Stars
- 6k
- Forks
- 1.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 10
Description
 |
@itamarst reported |
|---|---|
| Trac ID | trac#3126 |
| Type | enhancement |
| Created | 2008-03-26 15:39:21Z |
| Branch | https://github.com/twisted/twisted/tree/doc-deprecate-policy-3126 |
This would prevent having docs cover old rather than new APIs (e.g. the telnet howto.)
Searchable metadata
trac-id__3126 3126
type__enhancement enhancement
reporter__itamarst itamarst
priority__normal normal
milestone__
branch__branches_doc_deprecate_policy_3126 branches/doc-deprecate-policy-3126
branch_author__thijs thijs
status__assigned assigned
resolution__None None
component__core core
keywords__documentation documentation
time__1206545961000000 1206545961000000
changetime__1296134622000000 1296134622000000
version__None None
owner__
cc__exarkun cc__radix cc__glyph cc__jml cc__spiv cc__foom cc__thijs cc__khorn
Contributor guide
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
The issue points to the doc-deprecate-policy-3126 branch and uses the telnet howto as an example; start by reviewing that branch and the current coding standard. Define the deprecation guidance so documentation favors current APIs, then check that the affected documentation reflects the policy.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 20/100