search

twitter-archive / commons

Twitter common libraries for python and the JVM (deprecated)
http://twitter.github.com/commons
Other
2.1k stars 565 forks source link

Add TOC in style guide #465

Closed knjk04 closed 5 years ago

knjk04 commented 5 years ago

Problem

In the style guide, you have

[TOC]

but no table of contents. I added one in!

Relevant issue: https://github.com/twitter/commons/issues/463

Solution

Added a table of contents with links to the relevant sections.

Result

It doesn't affect the end user directly, but it can help other programmers find information in your style guide easier by having a way to reference specific sections.

CLAassistant commented 5 years ago

CLA assistant check
All committers have signed the CLA.

knjk04 commented 5 years ago

Closing because the name of the branch was incorrect. I renamed the branch and made further changes to the style guide, so I'll submit a new PR.