Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

struct/0 is displayed differently #1433

Closed
NickNeck opened this issue Nov 15, 2021 · 5 comments · Fixed by #1446
Closed

struct/0 is displayed differently #1433

NickNeck opened this issue Nov 15, 2021 · 5 comments · Fixed by #1446
Assignees
@eksperimental

Comments

@NickNeck
Copy link

When defstruct has an @doc annotation the function will be displayed as %MyStruct{} in the content area but the link in the sidebar has the text __struct__/0. Example: https://hexdocs.pm/elixir/1.12.3/Task.html#__struct__/0

Is this intended?
@josevalim
Copy link
Member

That's a bug. Thanks for the report!

@eksperimental
Copy link
Contributor

I can take care of this.

@eksperimental eksperimental self-assigned this Nov 15, 2021
@josevalim
Copy link
Member

@eksperimental ping :)

@eksperimental
Copy link
Contributor

Thank you for the reminder @josevalim , I totally forgot about this one.
I will take care of this within the next 24hrs

@josevalim
Copy link
Member

There is no rush, the ping was just in case you forgot about it. :)

eksperimental added a commit to eksperimental-forks/ex_doc that referenced this issue Dec 8, 2021
@eksperimental
Use Struct instead of __struct__/0 in sidebar
d77ee66 
Closes elixir-lang#1433
@eksperimental eksperimental mentioned this issue Dec 8, 2021
Merged
eksperimental added a commit that referenced this issue Dec 8, 2021
@eksperimental
Use Struct instead of __struct__/0 in sidebar (#1446)
7dbc937 
Closes #1433
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@eksperimental eksperimental

Labels
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Use Struct instead of __struct__/0 in sidebar eksperimental-forks/ex_doc
3 participants
@josevalim @NickNeck @eksperimental