Rich_Morin
Remove Phoenix functions from ExDoc View pages?
ExDoc adds documentation for several Phoenix functions to each of my View pages:
__phoenix_recompile__?()__resource__()__templates__()render(template, assigns \\ %{})template_not_found(template, assigns)
These entries (and their index entries) are basically noise, from my point of view. I suspect that they are being brought in via a use statement; is there a way to remove them?
Most Liked
outlog
benwilson512
Phoenix would probably accept a PR that added @doc false above them. Without that I don’t know of a way to remove them.
Rich_Morin
The template.ex and view.ex files already contain @doc entries for these functions. Because they are located inside macros, they get brought in by use statements. However, the code is beyond my pay grade to modify:
defmodule Phoenix.Template do
...
@doc false
defmacro __before_compile__(env) do
...
quote do
...
@doc """
Returns the template root alongside all templates.
"""
def __templates__ do
{@phoenix_root, @phoenix_pattern, unquote(names)}
end
...
end
It’s also possible that someone wants these functions to be documented in every View. So, before I even post an issue, I’d like to get a bit more feedback. (ducks)
Popular in Questions
Other popular topics
Categories:
Sub Categories:
Forums
Popular Tags
- #ecto
- #liveview
- #troubleshooting
- #learning-elixir
- #deployment
- #library
- #erlang
- #testing
- #genserver
- #mix
- #absinthe
- #remote-other
- #otp
- #plug
- #how-to-question
- #macros
- #postgres
- #channels
- #elixirconf
- #exunit
- #discussion
- #code-sync
- #javascript
- #podcasts
- #onsite
- #dialyzer
- #docker
- #authentication
- #umbrella
- #full-time-contract
- #podcasts-by-brainlid
- #ecto-query
- #elixir-ls
- #phoenix_html
- #iex
- #blog-post
- #graphql
- #genstage
- #ai
- #websockets
- #supervisor
- #advent-of-code
- #elixirconf-us
- #distillery
- #processes
- #forms
- #api
- #metaprogramming
- #security
- #performance








