-
Notifications
You must be signed in to change notification settings - Fork 373
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.
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
Should smart constructors for Rep* types in Yesod.Core.Content be marked as deprecated? #1780
Comments
I quickly looked up my usage of this system. I also use the recommended So for me, it sounds reasonable to deprecate the |
I think it's possible there are still cases where using the |
Currently, the functions
repJson
,repPlain
andrepXml
inYesod.Core.Content
have no documenting comments:yesod/yesod-core/src/Yesod/Core/Content.hs
Lines 149 to 156 in 26a195b
However when using these today and googling for information about the right way of using them, I came across this stack overflow question, which has an answer mentioning that this functionality is deprecated:
https://stackoverflow.com/a/17282601/2061783
A comment then goes on to link this changelog which mentions in 1.2:
So my thought was it would make sense to have access to this information on these functions (where I started) in the docs rather than having to get to StackOverflow.
If these functions are effectively deprecated by way of the types they construct being deprecated then I think we should have a deprecation warning for these, along with some comments explaining why they are deprecated and a way of addressing that.
If someone can point me in this direction, I am happy to do the change request to add this documentation, I just need to know what the appropriate suggestion is instead (or if there is some existing documentation that could be linked here)
The text was updated successfully, but these errors were encountered: