Skip to content

Fixing 'Example Code' #245

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

Merged
merged 8 commits into from
Jul 12, 2018
Merged

Fixing 'Example Code' #245

merged 8 commits into from
Jul 12, 2018

Conversation

Wesley-Arrington
Copy link
Contributor

  • Made 'Example Code' a consistent size throughout document
  • Added in 'Example Code' on several pages
  • Added in missing programming language titles

@Butt4cak3
Copy link
Contributor

I checked the changes in this PR for correctness and I can say there are no errors in it. I'd still like to pull @leios into this PR to discuss which size headline we want to use for "Example Code". In my opinion, it should be a H2 (##) because it should be one level lower than the chapter headline, which is a H1 (#) since the example code is part of the chapter and not a chapter in itself.

@leios
Copy link
Member

leios commented Jul 12, 2018

Yeah, agreed. If we could use ## instead of #, that would be nice. I use ## for all other section headings (I think)

@Butt4cak3
Copy link
Contributor

I just asked myself: Why do we even have the language headlines (### Java, ### Haskell, ...)? There is always only one programming language visible at a time anyway and we don't add headlines to the smaller code snippets. Honestly, I don't think we need those, but I want to hear what others think.

@Butt4cak3
Copy link
Contributor

Okay. The same question has been answered in another PR. I'd say we finish up this one first (change "Example Code" to ## instead of #) and then remove all the language headlines in another PR.

@leios
Copy link
Member

leios commented Jul 12, 2018

Yeah. Agreed. I want to merge #242 soon, too. I think it will break some PR's, though.

@Butt4cak3
Copy link
Contributor

It shouldn't break too much. Git properly detected all the file moves, so it should be able to handle it.

Copy link
Member

@leios leios left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A nice standardization of code titles.

@leios leios merged commit f756855 into algorithm-archivists:master Jul 12, 2018
@Wesley-Arrington Wesley-Arrington deleted the fixingMatrixMethodsMD branch July 12, 2018 08:20
@Wesley-Arrington
Copy link
Contributor Author

@Butt4cak3 I'll make that PR to remove language headlines :)

This was referenced Jul 12, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants