How to use type specs?

[akasprzok]

Seems that typespecs are created via a before_compile callback here

I've got a handful of compiled Protobufs in a .pb.ex file, including

defmodule Logproto.PushRequest do
  @moduledoc false
  use Protobuf, protoc_gen_elixir_version: "0.10.0", syntax: :proto3

  field(:streams, 1, repeated: true, type: Logproto.StreamAdapter, deprecated: false)
end

But whenever I run mix docs, using Logproto.PushRequest.t() in a typespec, I got warnings like

warning: documentation references type "Logproto.PushRequest.t()" but it is hidden or private

Will dig into this more, but is there something obvious I might be missing!

[whatyouhide]

Are you writing Logproto.PushRequest.t/0 or Logproto.PushRequest.t() in a documentation string?

[akasprzok]

For example:

@type timestamp :: Google.Protobuf.Timestamp.t()
@type entry: Logproto.EntryAdapter.t()

mix docs
...
warning: documentation references function "Google.Protobuf.Timestamp.new/0" but it is hidden
  lib/sleipnir/timestamp.ex:8: Sleipnir.Timestamp.new/0

warning: documentation references type "Logproto.EntryAdapter.t()" but it is hidden or private
  lib/sleipnir.ex:23: t:Sleipnir.entry/0

Can be repro'd using my little Loki client project, just run mix docs on main.

[whatyouhide]

I see. Opening an issue for this, it shouldn't warn.