Navigation Menu

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

Fix markdown formatting #534

Merged
merged 1 commit into from Apr 20, 2017
Merged

Fix markdown formatting #534

merged 1 commit into from Apr 20, 2017

Conversation

nurupo
Copy link
Member

@nurupo nurupo commented Apr 12, 2017

GitHub changed how their Markdown parser works in non-backwards-compatible way, breaking custom anchors and #Headings (it's now required to have a space after #).

There are lines with ####### in https://github.com/TokTok/c-toxcore/blob/master/docs/updates/Symmetric-NAT-Transversal.md. Not sure if they were rendered to anything, but they are not being rendered right now, which seems fine to me, so I haven't done anything about them.


This change is Reviewable

@nurupo nurupo added the documentation Changes to the documentation label Apr 12, 2017
@nurupo nurupo added this to the v0.1.8 milestone Apr 12, 2017
@robinlinden
Copy link
Member

Reviewed 3 of 3 files at r1.
Review status: all files reviewed at latest revision, 1 unresolved discussion.


INSTALL.md, line 22 at r1 (raw file):

    - [libtoxav](#libtoxav)
  - [Bootstrap daemon](#bootstrap-daemon)
  - [nTox](#ntox)

s/ntox/ntox-test-cli


Comments from Reviewable

@iphydf
Copy link
Member

iphydf commented Apr 12, 2017

:lgtm_strong: I put some comments, but they are just about fixing more markdown formatting, nothing about the current state. This is an improvement, so I'm happy after you fix @robinlinden's comment.


Review status: all files reviewed at latest revision, 3 unresolved discussions.


docs/av_api.md, line 11 at r1 (raw file):

function initializes sample phone. _listen_port and _send_port are variables only meant

`_listen_port` and the same for all other code fragments in the text.


docs/av_api.md, line 16 at r1 (raw file):

Phone requires one msi session and two rtp sessions ( one for audio and one for

Remove space after (.


Comments from Reviewable

@iphydf iphydf modified the milestones: v0.1.8, v0.1.9 Apr 12, 2017
@nurupo
Copy link
Member Author

nurupo commented Apr 13, 2017

Review status: all files reviewed at latest revision, 3 unresolved discussions, some commit checks failed.


INSTALL.md, line 22 at r1 (raw file):

Previously, robinlinden (Robin Lindén) wrote…

s/ntox/ntox-test-cli

Nice catch.


docs/av_api.md, line 11 at r1 (raw file):

Previously, iphydf wrote…

`_listen_port` and the same for all other code fragments in the text.

In this PR I aim to fix markdown files that have rendered correctly before but because of GitHub changing its markdown parser no longer render correctly. Changes like the one you ask me here are out of scope of what I want to do in this PR.


Comments from Reviewable

@nurupo
Copy link
Member Author

nurupo commented Apr 13, 2017

Review status: 2 of 3 files reviewed at latest revision, 3 unresolved discussions, some commit checks failed.


INSTALL.md, line 22 at r1 (raw file):

Previously, nurupo wrote…

Nice catch.

Should be fixed now.


Comments from Reviewable

@robinlinden
Copy link
Member

:lgtm_strong:


Reviewed 1 of 1 files at r2.
Review status: all files reviewed at latest revision, 2 unresolved discussions, some commit checks failed.


Comments from Reviewable

@iphydf
Copy link
Member

iphydf commented Apr 18, 2017

@nurupo, can you rebase and merge? You have merge rights, so just go ahead (and change the milestone to 0.1.8 if you do it before that's released).

@nurupo
Copy link
Member Author

nurupo commented Apr 20, 2017

Rebased. @robinlinden you can merge now!

@iphydf iphydf merged commit f6285d7 into TokTok:master Apr 20, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Changes to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants