Skip to content

Addition of TOCs in Markdown files #158

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 5 commits into from
Mar 21, 2020
Merged

Addition of TOCs in Markdown files #158

merged 5 commits into from
Mar 21, 2020

Conversation

jvdp1
Copy link
Member

@jvdp1 jvdp1 commented Mar 14, 2020

Some specs already contain multiple functions. So I thought it could be good to add TOCs for clarity.
Of course, it can be discussed/modified/removed, as usual.

@nshaffer
Copy link
Contributor

Nothing obviously amiss, except the vim plugin magic comment thing.

Links for each routine are obviously useful and good to have. Subsection links (Description, etc.) don't seem useful, though.

@jvdp1
Copy link
Member Author

jvdp1 commented Mar 18, 2020

Nothing obviously amiss, except the vim plugin magic comment thing.

Links for each routine are obviously useful and good to have. Subsection links (Description, etc.) don't seem useful, though.

Thanks @nshaffer for the review. I will remove Vim comments and subsection links (Their are indeed all the same).

Copy link
Member

@milancurcic milancurcic left a comment

Choose a reason for hiding this comment

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

Looks great! My only suggestion is to remove the "Implemented" heading from the top of each spec file--it serves no purpose, and in some files it's incorrect (for example, in quadrature it lists some functions that aren't implemented).

@certik
Copy link
Member

certik commented Mar 21, 2020 via email

@jvdp1
Copy link
Member Author

jvdp1 commented Mar 21, 2020

Looks great! My only suggestion is to remove the "Implemented" heading from the top of each spec file--it serves no purpose, and in some files it's incorrect (for example, in quadrature it lists some functions that aren't implemented).

Thank you @milancurcic. Suggestion applied.

@jvdp1
Copy link
Member Author

jvdp1 commented Mar 21, 2020

Ok. I will merge. Thank you for your comments.

@jvdp1 jvdp1 merged commit 5d1e091 into fortran-lang:master Mar 21, 2020
@jvdp1 jvdp1 deleted the toc_md branch March 26, 2020 20:52
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.

4 participants