Updating sgf-parsing exercise instructions

The second line in the sgf-parsing exercise docs says:

[SGF](https://en.wikipedia.org/wiki/Smart_Game_Format) is a standard format for storing board game files, in particular go.

Main issue is that the ‘go’ should be written as ‘Go’. Also, it’s not clear it refers to the game of Go unless someone clicks the link. I propose the following change:

[SGF](https://en.wikipedia.org/wiki/Smart_Game_Format) is a standard format for storing board game files, particularly for the game of Go.

or

[SGF](https://en.wikipedia.org/wiki/Smart_Game_Format) is a standard format for storing board game files, particularly for Go.

Other issues include:

  1. Missing punctuation in few places.
  2. Not one sentence per line in multiple places.

A link for Go could be helpful, too. I think a PR would be good.

Adding a link to Go crossed my mind, but then i realized that the linked article talks mostly about Go and has plenty of links to its Wikipedia page. Maybe an extra link from the instructions.md is a bit redundant? Or, is it still good practice?

Also, lines 57-59 say:

All property values will be the [SGF Text type][sgf-text]. You don't need to implement any other value type. Although you can read the [full documentation of the Text type][sgf-text], a summary of the important points is below:

Note that this has both ‘SGF Text type’ and ‘full documentation of the Text type’ pointing to the exact same link ‘sgf-text’. I think the second link can be safely removed.

I’ve noticed that the backticks were not used consistently, so i’ve fixed those as well.

Here are the current commits

Content-wise I think these changes are great, thank you :) But is the one-sentence-per-line thing an Exercism in-house style guide rule or something? I’ve never seen it used in Markdown before, I’ve always seen it wrapped at a fixed length like 80 or 120.

It looks weird to me so I’m curious if it’s an Exercism convention.

It’s the Exercism style. It makes life a whole lot easier when updating a sentence at the beginning of a paragraph; you don’t need to rewrap the entire paragraph.

2 Likes

https://asciidoctor.org/docs/asciidoc-recommended-practices/#one-sentence-per-line

Diffs become a lot easier to read when using one line per sentence.

2 Likes