Giter VIP home page Giter VIP logo

Comments (2)

Cleop avatar Cleop commented on May 20, 2024 1
  • Add a note that correct documentation will show a user how to correctly run the function. I skimmed this and got confused when implementing randomise!

  • Explain basic error messages? Like:

image

Ie. that the randomise functions expects to receive 1 argument.

  • Etiquette for documenting functions, the examples have documentation but it might be helpful to have a note saying, you should always write documentation before creating a function or devs tend to do documentation in batches or whatever the correct etiquette is!

from learn-elixir.

Cleop avatar Cleop commented on May 20, 2024
  • Think about order/ route of someone's learning based on resources suggested.
    Ie. Elixir School, our exercises, videos etc.
  • Add line about what the README will teach you. Ie. introduce you to basic types and then run your through project set up and some basic examples. This will help readers gauge whether the README is at the right experience level for them and whether it's going to help them achieve what they're setting out to achieve.

from learn-elixir.

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.