Skip to content

Make behaviour_info more accessible in documentation #13733

Closed
@whatyouhide

Description

@whatyouhide

Right now, if you want to get information about the behaviour_info/1 function that gets generated in behaviours, you have to do one of the following:

  • Go to the docs for the Behaviour module. This is bad as that module is deprecated.
  • Google behaviour_info elixir, which returns sucky results (screenshot below)
  • Google behaviour_info erlang, where for me the third result is the Modules Erlang docs, where then I have to search behaviour_info in the page.

This is all not ideal IMO, can we make it better? I’m a bit out of ideas. We could implement a mock Kernel.behaviour_info/1 function just to document stuff, but I’m not sure that's a good solution. Thoughts?

CleanShot 2024-07-23 at 16 02 31@2x

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions