Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Move socket options from API.md to a separate document #1378

Closed
maxsharabayko opened this issue Jun 25, 2020 · 0 comments · Fixed by #1510
Closed

[docs] Move socket options from API.md to a separate document #1378

maxsharabayko opened this issue Jun 25, 2020 · 0 comments · Fixed by #1510
Assignees
Labels
[docs] Area: Improvements or additions to documentation Type: Maintenance Work required to maintain or clean up the code
Milestone

Comments

@maxsharabayko
Copy link
Collaborator

maxsharabayko commented Jun 25, 2020

API.md document is very overloaded and not conveniently structured.
SRT socket options should be moved to a separate document similar to statistics.md with a similar summary table.

The API.md file contains a full list of socket options, which is purely readable and does not allow to reference a certain socket option in discussions. Consider moving the list to a separate document APISocketOptions.md with a structure like in the statistics.md.
Move the options section from API.md to APISocketOptions.md. Merge all per-socket tables with all their columns (OptName, Since, Binding, Type, etc.) into a single table. Each socket option should have a link to the description of the option (see statistics.md).

@maxsharabayko maxsharabayko added Type: Maintenance Work required to maintain or clean up the code [docs] Area: Improvements or additions to documentation labels Jun 25, 2020
@maxsharabayko maxsharabayko added this to the v1.5.0 milestone Jun 25, 2020
@maxsharabayko maxsharabayko linked a pull request Sep 1, 2020 that will close this issue
@mbakholdina mbakholdina modified the milestones: v1.5.0, v1.4.2 Oct 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[docs] Area: Improvements or additions to documentation Type: Maintenance Work required to maintain or clean up the code
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants