Document "TrafficClass" option

Open
#264 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

Start by locating the existing documentation or configuration reference for the TrafficClass option. Document what the integer represents, including how any hexadecimal or bitmask values map to the expected decimal input, and make the supported values understandable to users.

Written by the indexing model from the issue text.

Description

It takes some sort of integer. I sort of know what it is and could google what numbers are supposed to represent what, but it would be in hex or bitmasks or something and we expect a decimal integer. No user is going to sort this out on their own, so we need at the least some sort of page on what it means.

Summoning @AudriusButkevicius

Dominant language
Python
Stars
327
Forks
653
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from syncthing/docs

All issues in syncthing/docs

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.