Git Product home page Git Product logo

Comments (11)

evanplaice avatar evanplaice commented on August 24, 2024 1

Are we good to drop 1.0?

from absurdum.

evanplaice avatar evanplaice commented on August 24, 2024

I have exhaustingly reviewed the list of operators. Everything that should be included is included, everything that shouldn't be included isn't. The only exceptions are map/filter. Should these be removed as well?

IMO, the README.md could use some work. Remove the "Funky Name" and "What's the Point" sections. Maybe add a section explainer that talks about the functional nature of these components.

Also, I think the operators listing would look better as a table. Possibly with columns for polyfill and links to the lodash equivalent.

@jkvyff What do you think?

from absurdum.

jkvyff avatar jkvyff commented on August 24, 2024

By a polyfill column, do you mean the functions that would require a polyfill to be IE compatible?

from absurdum.

evanplaice avatar evanplaice commented on August 24, 2024

Functions that could be used as polyfills because they don't exist in IE11

Name it "Polyfills" then add a link to the function/method on MDN.

I have the table partway done. I'll ping you to check it out once it's ready.

from absurdum.

jkvyff avatar jkvyff commented on August 24, 2024

A few notes:

  • Both map and filter seem to be kept in many other utility libraries, while they aren't so useful as they are methods already built into the language. I do believe they serve an important purpose in being one of the first methods someone looking at source could turn to when seeing what an implementation prioritizes through a simple example.
  • Sounds good on the readme, ill do that today
  • should documentation names be standardized more (eg. predicate, func | element, value)?

from absurdum.

evanplaice avatar evanplaice commented on August 24, 2024
  • Cool
  • Good point about map/filter. I was a bit conflicted b/c I've been in chopping block mode lately but I agree.
  • don't worry about the operators table in the README.md. I'll have that done this afternoon.
  • Yes, I wasn't sure if we should do this before or after 1.0. ITT, all the docs could use a good once-over to locate and fix any inconsistencies.

I'm trying to find a better JSDoc -> MD conversion tool so we have more control over the output and can support multiple example tags. ESDoc would be the most promising but the project is currently dead and I haven't received a response back from the maintainer so it's probably a dead end.

from absurdum.

jkvyff avatar jkvyff commented on August 24, 2024

Might be able to reach the ESDoc2 person, though project is about the same level of active.

from absurdum.

evanplaice avatar evanplaice commented on August 24, 2024

Probably not worth the time. I don't just need ESDoc, I would also need to finish building the Markdown output.

from absurdum.

jkvyff avatar jkvyff commented on August 24, 2024

I'm down to do a standardization of docs before 1.0, as it would still just be what is glaring for me.

Do:

  • standardize terminology, as mentioned before
  • fix typos or misspellings
  • adding optional before optional parameter description

Delay:

  • Rewordings of definitions for clarity
  • Adding examples for each type of way to use function

from absurdum.

evanplaice avatar evanplaice commented on August 24, 2024

Sounds good to me. 1.0 can drop whenever we feel it's ready.

from absurdum.

evanplaice avatar evanplaice commented on August 24, 2024

1.0 Released 👍

from absurdum.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.