You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When building a project that contains any Surface component (i.e. any module using Component, LiveView, LiveComponent or MacroComponent) with @moduledoc false, compilation fails with the following error:
Expected Behavior
The project should compile successfully.
Current Behavior
Compilation fails.
Possible Solution
Adding the following arm to the case statement of Surface.API.generate_docs/1 appears to fix the issue:
{_line,false}->{env.line,props.doc}
This solution returns the same doc as if the @moduledocattribute was not specified at all.
Steps to Reproduce
Create a mix project
Add Surface as a dependency
Create a module with using Surface.Component and @moduledoc false
Run mix compile
Context (Environment)
Elixir version: 1.10.3-otp-22
Surface version: Latest from master
If this an actual issue and the proposed solution is acceptable I would be happy to submit a PR to fix this!
The text was updated successfully, but these errors were encountered:
When building a project that contains any Surface component (i.e. any module using Component, LiveView, LiveComponent or MacroComponent) with
@moduledoc false
, compilation fails with the following error:Expected Behavior
The project should compile successfully.
Current Behavior
Compilation fails.
Possible Solution
Adding the following arm to the
case
statement of Surface.API.generate_docs/1 appears to fix the issue:This solution returns the same doc as if the
@moduledoc
attribute was not specified at all.Steps to Reproduce
using Surface.Component
and@moduledoc false
mix compile
Context (Environment)
Elixir version: 1.10.3-otp-22
Surface version: Latest from master
If this an actual issue and the proposed solution is acceptable I would be happy to submit a PR to fix this!
The text was updated successfully, but these errors were encountered: