Skip to content

Remove spurious doc comment on CoreFn Module#3552

Merged
hdgarrood merged 2 commits intopurescript:masterfrom
jmackie:patch-4
Sep 9, 2020
Merged

Remove spurious doc comment on CoreFn Module#3552
hdgarrood merged 2 commits intopurescript:masterfrom
jmackie:patch-4

Conversation

@jmackie
Copy link

@jmackie jmackie commented Mar 6, 2019

There have clearly been several changes since this comment was written, and is now incorrect. Best to remove it.

There have clearly been several changes since this comment was written, and this comment is now incorrect. Best to remove it.
@hdgarrood
Copy link
Contributor

I'm not very familiar with this part of the compiler; can you explain why it's incorrect?

@natefaubion
Copy link
Contributor

I think everything about the names is wrong, and this comment is definitely in the wrong place. I think it's important to document that we are not serializing types, but that should probably go in ToJSON/FromJSON.

@rhendric
Copy link
Member

rhendric commented Sep 2, 2020

There are no types in CoreFn to serialize. If that fact needs to be called out explicitly, here is as good a place as any, but then the comment would just be -- The CoreFn representation does not contain type information.. Personally, I think @jmackie is correct: this comment is obsolete and can be dropped with prejudice.

Copy link
Contributor

@hdgarrood hdgarrood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, that's good enough for me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

Comments