Confused... [image: image.png] https://github.com/elixir-lang/ex_doc/pull/879
English3000.org: *A data-driven approach to language learning.* On Fri, Sep 14, 2018 at 10:30 AM José Valim <[email protected]> wrote: > Yes, somebody needs to do this work in ExDoc though. Design the feature, > propose and implement it. Once this is supported in ExDoc, then we can > discuss the best way to leverage it from Elixir itself. > > > > *José Valim* > www.plataformatec.com.br > Skype: jv.ptec > Founder and Director of R&D > > On Fri, Sep 14, 2018 at 7:25 PM, Alexander Marks-Katz < > [email protected]> wrote: > >> Ok, then display them like you display the `since` data. >> >> And then add an advanced search feature (under the search bar) that >> leverages the tags to make functions show up by category. >> >> >> English3000.org: *A data-driven approach to language learning.* >> >> >> On Fri, Sep 14, 2018 at 10:15 AM José Valim < >> [email protected]> wrote: >> >>> Well, it is definitely a debate because, although the mechanism is >>> available we still need to debate: >>> >>> 1. if we will add the tags to Elixir >>> 2. and then if we will include those categories in Elixir's own docs >>> >>> Keep in mind the current categories implementation completely segregate >>> functions in the sidebar, messing up the alphabetical ordering. And every >>> time we messed up with the alphabetical ordering, people got really upset, >>> as it made looking for a particular function (or something that you know >>> exists but you are not quite sure about the name) much harder. >>> >>> So my initial response is that we won't add more categories to Elixir >>> itself unless we find another way to show them that doesn't mess with the >>> alphabetical ordering in the documentation sidebar. Otherwise it will be >>> just a matter of time before people ask us to remove the categories. >>> >>> >>> >>> >>> >>> *José Valim* >>> www.plataformatec.com.br >>> Skype: jv.ptec >>> Founder and Director of R&D >>> >>> On Fri, Sep 14, 2018 at 7:01 PM, Alexander Marks-Katz < >>> [email protected]> wrote: >>> >>>> Also, this isn't a debate. The mechanism has already been implemented: >>>> https://github.com/elixir-lang/ex_doc/issues/876 >>>> >>>> English3000.org: *A data-driven approach to language learning.* >>>> >>>> >>>> On Fri, Sep 14, 2018 at 9:52 AM Alexander Marks-Katz < >>>> [email protected]> wrote: >>>> >>>>> No. Data structure-based modules *already* exist. I'm referring to >>>>> `Conversions`, `Data`, `Operations`, etc. as tags. >>>>> >>>>> To help you understand, I'm talking about differences between >>>>> functions like how words have different parts of speech. I'm not talking >>>>> about the difference between numbers and words. >>>>> >>>>> Across all data structure modules, there are functions that >>>>> specifically exist to *convert* that data structure to another. >>>>> Making that distinct from other grouping/categories will make the >>>>> documentation *significantly* more reasonable and allow newcomers to >>>>> notice useful functions by grouping that they don't with an alphabetized >>>>> list. >>>>> >>>>> Point being, you wouldn't put a function for integers in the `String` >>>>> module, so why would you put functions that convert data, operate on it, >>>>> and give metadata on it all mixed together--as opposed to grouping them >>>>> within the module. >>>>> >>>>> English3000.org: *A data-driven approach to language learning.* >>>>> >>>>> >>>>> On Fri, Sep 14, 2018 at 1:38 AM Sven Gehring <[email protected]> wrote: >>>>> >>>>>> I don't think forum discussions and function documentation can >>>>>> necessarily be compared. >>>>>> >>>>>> If I understand the contents of the example repo right, you'd want to >>>>>> tag functions by the type of their arguments (e.g. which data structures >>>>>> they operate on). >>>>>> This is largely already sorted by how they are organized in modules >>>>>> (Enum, String, etc.) I would go as far as saying those modules ARE >>>>>> categories of functions. >>>>>> >>>>>> Adding an additional way of sorting the documentation would be more >>>>>> confusing than helpful in my opinion. >>>>>> Personally, I also never had any issues finding functions, even when >>>>>> I started learning Elixir >>>>>> >>>>>> On Fri, 14 Sep 2018 at 04:47 <[email protected]> wrote: >>>>>> >>>>>>> Just as we can tag discussions on Elixir Forum, making them more >>>>>>> searchable, Elixir core's functions should be tagged. >>>>>>> >>>>>>> This will make the Hex docs *significantly* more beginner-friendly >>>>>>> and will give the core team a more systematic way to track the size and >>>>>>> scope of the kernel. >>>>>>> >>>>>>> `@doc` could accept a `:category` tag (I've made a repo >>>>>>> <https://github.com/English3000/elixir_vocab> *[in progress]* >>>>>>> categorizing the more commonly used functions from the basic data >>>>>>> structure >>>>>>> modules). >>>>>>> >>>>>>> To make tags even more powerful, you can add an `:equivalents` (or >>>>>>> `:delegates`) tag which would accept a list of functions that do the >>>>>>> same >>>>>>> thing or something very similar. >>>>>>> >>>>>>> -- >>>>>>> You received this message because you are subscribed to the Google >>>>>>> Groups "elixir-lang-core" group. >>>>>>> To unsubscribe from this group and stop receiving emails from it, >>>>>>> send an email to [email protected]. >>>>>>> To view this discussion on the web visit >>>>>>> https://groups.google.com/d/msgid/elixir-lang-core/d370cbf9-92d0-4814-8332-54189634842e%40googlegroups.com >>>>>>> <https://groups.google.com/d/msgid/elixir-lang-core/d370cbf9-92d0-4814-8332-54189634842e%40googlegroups.com?utm_medium=email&utm_source=footer> >>>>>>> . >>>>>>> For more options, visit https://groups.google.com/d/optout. >>>>>>> >>>>>> -- >>>>>> You received this message because you are subscribed to a topic in >>>>>> the Google Groups "elixir-lang-core" group. >>>>>> To unsubscribe from this topic, visit >>>>>> https://groups.google.com/d/topic/elixir-lang-core/TxDvKFwltZU/unsubscribe >>>>>> . >>>>>> To unsubscribe from this group and all its topics, send an email to >>>>>> [email protected]. >>>>>> To view this discussion on the web visit >>>>>> https://groups.google.com/d/msgid/elixir-lang-core/CAFuVuxwMu3wh%3DC%2B2Lo2emziY%3DMZAucxXqUCrsMdTLrL3bL4bRQ%40mail.gmail.com >>>>>> <https://groups.google.com/d/msgid/elixir-lang-core/CAFuVuxwMu3wh%3DC%2B2Lo2emziY%3DMZAucxXqUCrsMdTLrL3bL4bRQ%40mail.gmail.com?utm_medium=email&utm_source=footer> >>>>>> . >>>>>> For more options, visit https://groups.google.com/d/optout. >>>>>> >>>>> -- >>>> You received this message because you are subscribed to the Google >>>> Groups "elixir-lang-core" group. >>>> To unsubscribe from this group and stop receiving emails from it, send >>>> an email to [email protected]. >>>> To view this discussion on the web visit >>>> https://groups.google.com/d/msgid/elixir-lang-core/CAF9bs6RZHCC89TNF1YuWaEgCvRw1sDy%2BZWejBWfSeKreWMPhrQ%40mail.gmail.com >>>> <https://groups.google.com/d/msgid/elixir-lang-core/CAF9bs6RZHCC89TNF1YuWaEgCvRw1sDy%2BZWejBWfSeKreWMPhrQ%40mail.gmail.com?utm_medium=email&utm_source=footer> >>>> . >>>> >>>> For more options, visit https://groups.google.com/d/optout. >>>> >>> >>> -- >>> You received this message because you are subscribed to a topic in the >>> Google Groups "elixir-lang-core" group. >>> To unsubscribe from this topic, visit >>> https://groups.google.com/d/topic/elixir-lang-core/TxDvKFwltZU/unsubscribe >>> . >>> To unsubscribe from this group and all its topics, send an email to >>> [email protected]. >>> To view this discussion on the web visit >>> https://groups.google.com/d/msgid/elixir-lang-core/CAGnRm4%2B%2BuSXj-L32qK9mdsMq-Lf6cCsAcKDtRqKzBa5%2B0QoGsA%40mail.gmail.com >>> <https://groups.google.com/d/msgid/elixir-lang-core/CAGnRm4%2B%2BuSXj-L32qK9mdsMq-Lf6cCsAcKDtRqKzBa5%2B0QoGsA%40mail.gmail.com?utm_medium=email&utm_source=footer> >>> . >>> For more options, visit https://groups.google.com/d/optout. >>> >> -- >> You received this message because you are subscribed to the Google Groups >> "elixir-lang-core" group. >> To unsubscribe from this group and stop receiving emails from it, send an >> email to [email protected]. >> To view this discussion on the web visit >> https://groups.google.com/d/msgid/elixir-lang-core/CAF9bs6Tadgkb7LBbmqYs73W0WSmxg_2vHNJffg%2BTRUY7bm3ROA%40mail.gmail.com >> <https://groups.google.com/d/msgid/elixir-lang-core/CAF9bs6Tadgkb7LBbmqYs73W0WSmxg_2vHNJffg%2BTRUY7bm3ROA%40mail.gmail.com?utm_medium=email&utm_source=footer> >> . >> For more options, visit https://groups.google.com/d/optout. >> > > -- > You received this message because you are subscribed to a topic in the > Google Groups "elixir-lang-core" group. > To unsubscribe from this topic, visit > https://groups.google.com/d/topic/elixir-lang-core/TxDvKFwltZU/unsubscribe > . > To unsubscribe from this group and all its topics, send an email to > [email protected]. > To view this discussion on the web visit > https://groups.google.com/d/msgid/elixir-lang-core/CAGnRm4JfqMQp3DuAdBGBaFwUrsoaq2wzqBj55SiCGhcF_YXEAA%40mail.gmail.com > <https://groups.google.com/d/msgid/elixir-lang-core/CAGnRm4JfqMQp3DuAdBGBaFwUrsoaq2wzqBj55SiCGhcF_YXEAA%40mail.gmail.com?utm_medium=email&utm_source=footer> > . > For more options, visit https://groups.google.com/d/optout. > -- You received this message because you are subscribed to the Google Groups "elixir-lang-core" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/elixir-lang-core/CAF9bs6TyzGtdJ_GeKm%3DP0-Ae0tNZN2_%3DULuHWUy7XE6ESZcDDg%40mail.gmail.com. For more options, visit https://groups.google.com/d/optout.
