Skip to content

Add missing module and function docs #34

@juanhurtado10

Description

@juanhurtado10

Context

Elixir treats documentation as a first-class citizen. This means documentation should be easy to write and read to everyone.

Objective

  • To set a documentation standard for the library.
  • To add missing modules and functions docs for all the XDR types.
  • To improve the current docs

References

Format

defmodule Greeter do
  @moduledoc """
  ...
  """

  @doc """
  Prints a hello message

  ## Parameters

    - name: String that represents the name of the person.

  ## Examples

      iex> Greeter.hello("Sean")
      "Hello, Sean"

      iex> Greeter.hello("pete")
      "Hello, pete"

  """
  @spec hello(String.t()) :: String.t()
  def hello(name) do
    "Hello, " <> name
  end
end

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions