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 typos in Formal Languages chapter #385

merged 8 commits into from Sep 13, 2016


2 participants

StevenMaude commented Sep 7, 2016

Proposed changes

Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request:

Fixes small typos in the Formal Languages chapter.

Additionally, makes the glossary entry for Finite State Automaton display correctly.


Put an x in the boxes that apply. You can also fill these out after creating the pull request. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your change.

  • I have read the contribution guidelines
  • I have linked any relevant existing issues/suggestions in the description above (include #??? in your description to reference an issue, where ??? is the issue number)
  • I have applied the relevant labels for this change
  • I have run the generation script and checked the output
  • I have added necessary documentation (if appropriate)

Further comments

If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc. Feel free to add any images that might be helpful to understand the initial problem/solution.

The fix for making the Finite State Automaton glossary entry display was to switch double quotes to single inside the definition, which might not be quite as you'd like. However, there doesn't seem to be a way to escape the double quote, it's treated as ending the glossary definition early, so seemed preferable in that it at least makes all the text appear for now.

StevenMaude added some commits Sep 7, 2016

Change "two" technical terms to "four"
As there are four detailed following that sentence.
Add quotes around "a" and "b" for clarity
Helps the inputs stand out from text, and in keeping with the rest of
the surrounding text.
Correct an accepted input in example
If "a" must be followed by "b", then "bbb" would not be accepted,
whereas "abb" (already listed) and "bab" would be accepted.

So, changed "bbb" to "bab".
Switch double quotes to single in FSA definition
The double quotes inside the text end up ending the definition early,
truncating the output.

This might not be an ideal fix, but at least makes the text display for

@StevenMaude StevenMaude changed the title from Guide content/formal languages typo fixes to Fix typos in Formal Languages chapter Sep 7, 2016

@JackMorganNZ JackMorganNZ merged commit 25d1e08 into uccser:develop Sep 13, 2016

1 of 2 checks passed

codeclimate Code Climate found 5 new issues and 5 fixed issues.
continuous-integration/travis-ci/pr The Travis CI build passed

This comment has been minimized.

Show comment
Hide comment

JackMorganNZ Sep 13, 2016


Thanks so much @StevenMaude for your hard work!


JackMorganNZ commented Sep 13, 2016

Thanks so much @StevenMaude for your hard work!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment