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

Sorted #57

Closed
wants to merge 2 commits into from
Closed

Sorted #57

wants to merge 2 commits into from

Conversation

AlexScheller
Copy link

@AlexScheller AlexScheller commented Jul 24, 2016

Not sure if you all are interested in this but some dude on reddit made a comment about how the readme.md isn't alphabetized so I wrote a little script to sort the relevant sections of the readme.md without ruining the markdown. It relies on the format not changing too much, but it works. I've also run it on the readme.md file so I'm submitting the alphabetized version of that too. The intent is that people contributing examples wouldn't need to worry about hand alphabetizing in the future. I'm up for making it more robust, better commented and cleaner if it gets picked up.

@jethrolarson
Copy link
Collaborator

I'm not 100% sure it should be alphabetized. What's the reddit thread?

@jethrolarson
Copy link
Collaborator

Also you shouldn't have to alphabetize the TOC, just regenerate the TOC after sorting the rest

@AlexScheller
Copy link
Author

https://www.reddit.com/r/programming/comments/4u9c3a/functional_programming_jargon_defined_in_plain/

Yeah if it doesn't need to be alphabetized or some other structure is preferred that's fine. It was just one comment in the thread, but I had time to write something up. About generating the TOC, is that a function of the markdown itself, or did you mean rewrite the progeram to generate it rather than sort the static list?

@jethrolarson
Copy link
Collaborator

There's a script in the package.json npm run toc or something like that

On Sat, Jul 23, 2016, 9:10 PM AlexScheller notifications@github.com wrote:

https://www.reddit.com/r/programming/comments/4u9c3a/functional_programming_jargon_defined_in_plain/

Yeah if it doesn't need to be alphabetized or some other structure is
preferred that's fine. It was just one comment in the thread, but I had
time to write something up. About generating the TOC, is that a function of
the markdown itself, or did you mean rewrite the progeram to generate it
rather than sort the static list?


You are receiving this because you commented.

Reply to this email directly, view it on GitHub
#57 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AAB-4JbqrtHnzE-jJoARGiQjINfyQrwxks5qYuXIgaJpZM4JTfTo
.

@hemanth
Copy link
Owner

hemanth commented Jul 24, 2016

@AlexScheller Currently we are using roadmarks, feel free to change as per the need, thanks!

@AlexScheller
Copy link
Author

Oh can't believe I missed that thanks.

@clarus
Copy link

clarus commented Jul 24, 2016

👍 for sorting! It feels easier to me when I want to go back to some definition I have already seen. Also, maybe adding (and then maintaining) a script for sorting is overkill compared to enforcing this convention for new contributions.

@hemanth
Copy link
Owner

hemanth commented Jul 25, 2016

enforcing this convention for new contributions.

Would be an over head for the contributors.

Better to have a post commit hook to sort!

@galtenberg
Copy link

galtenberg commented Dec 21, 2016

👎 for sorting - I'd recommend, in fact, to order the README from simpler concepts to more complex concepts, since the goal of the repo as stated is we hope to make learning FP easier.

(Being a tutorial over being a strict glossary. Building on earlier concepts, building momentum for visitors.)

Maybe a secondary section could have an alphabetized list of the concepts.

Thanks for all the great work! Really eye opening.

@jethrolarson
Copy link
Collaborator

jethrolarson commented Dec 21, 2016 via email

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.

None yet

5 participants