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

Improve fp doc generation #1963

Merged
merged 9 commits into from Feb 10, 2016

Conversation

4 participants
@jfmengels
Copy link
Member

commented Feb 9, 2016

This is a follow-up to the work done in #1897, and adds a lot of changes to improve the signature of the methods and the examples in the generated docs.
I have compiled a list of changes in this gist, and the current result of the generation is available there too.

There is still a few things to do/fix (also listed in the gist, including converting the tests I wrote to QUnit), and ultimately, some examples will have to be adapted (either in this PR or later) because they won't make that much sense. For example: pullAt, set. Mostly the methods mutating the entry and therefore using console.logs(), and the examples that use too many arguments than are supported in fp.

Anyway, I was told it would be nice to share my progress, so there you go ;)

@jfmengels jfmengels force-pushed the jfmengels:improve-fp-docs branch 2 times, most recently from 0f5dc66 to 79cb87b Feb 9, 2016

@jdalton jdalton force-pushed the lodash:master branch from 9c23ea0 to 967c0be Feb 9, 2016

@jdalton

This comment has been minimized.

Copy link
Member

commented Feb 9, 2016

Can you rebase this and any opportunity to squash some commits is a good thing.

@jfmengels jfmengels force-pushed the jfmengels:improve-fp-docs branch from 79cb87b to cb63e64 Feb 9, 2016

@jfmengels

This comment has been minimized.

Copy link
Member Author

commented Feb 9, 2016

Rebased and squashed it. Got it down to four (relatively big) commits.

msmorgan and others added some commits Feb 8, 2016

Merge pull request #1961 from msmorgan/master
Added support for variable-depth flatten.

@jfmengels jfmengels force-pushed the jfmengels:improve-fp-docs branch from cb63e64 to 9340995 Feb 10, 2016

@jfmengels jfmengels force-pushed the jfmengels:improve-fp-docs branch from 9340995 to 860ef55 Feb 10, 2016

@jfmengels jfmengels force-pushed the jfmengels:improve-fp-docs branch from 860ef55 to b59488b Feb 10, 2016

@jdalton jdalton force-pushed the lodash:master branch from 75a0dfc to 1e54a7a Feb 10, 2016

jdalton added a commit that referenced this pull request Feb 10, 2016

@jdalton jdalton merged commit 8921754 into lodash:master Feb 10, 2016

1 check was pending

continuous-integration/travis-ci/pr The Travis CI build is in progress
Details
@jfmengels

This comment has been minimized.

Copy link
Member Author

commented Feb 10, 2016

Ok, well, I think I've ended at a somewhat pretty satisfying point. I've done all the improvements that I currently could think of.

Current pain points are all the examples that are still broken, mostly because the examples given don't make sense in FP:

@jdalton

This comment has been minimized.

Copy link
Member

commented Feb 10, 2016

That's cool. I wouldn't worry too much about it. We could always inject a "Note" into the mutation methods that state the example should be taken with a grain of salt.

@jfmengels

This comment has been minimized.

Copy link
Member Author

commented Feb 10, 2016

Agreed, but I'm sure some examples could be rewritten so that it works in both modes, but this can be an ongoing process.

Do you have any idea on when this could get published on the website? Waiting for lodash/lodash.com#8 to advance?

Thanks for merging the PR, hope you like it, and let me know if you want some improvements on this part :)

@jdalton

This comment has been minimized.

Copy link
Member

commented Feb 10, 2016

Do you have any idea on when this could get published on the website?

I'll clean it up this go around. I imagine the bump after next will see it. I generate our current docs by pointing its markdown to html converter to a https://rawgit.com of a gist of our documentation. I could do the same for the fp docs (not a ton of work there).

Beyond this I'd dig entries in the build-differences or a separate wiki just for fp.
I'd like to cover the what, why, how of it and touch on the new fp convert options.

@jfmengels jfmengels deleted the jfmengels:improve-fp-docs branch Feb 10, 2016

jfmengels referenced this pull request Feb 18, 2016

@doug-numetric

This comment has been minimized.

Copy link

commented Oct 9, 2018

pullAt fp says:

Removes elements from array corresponding to indexes and returns an array of removed elements.

But the fp version of pullAt actually returns a new array without the removed elements...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.