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.

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

Documentation of FromDataSimple doesn't say it's only for debugging #1171

Closed
malaire opened this issue Nov 24, 2019 · 2 comments
Closed

Documentation of FromDataSimple doesn't say it's only for debugging #1171

malaire opened this issue Nov 24, 2019 · 2 comments
Labels
docs Improvements or additions to documentation no bug The reported bug was confirmed nonexistent

Comments

@malaire
Copy link

malaire commented Nov 24, 2019

The documentation of FromDataSimple doesn't mention that it's only for debugging. This is only mentioned at documentation of FromData.

Based on several closed issued about this and recent message at #beginners, this causes enough confusion that documentation of FromDataSimple should also mention this.

@jebrosen
Copy link
Collaborator

The documentation of FromDataSimple doesn't mention that it's only for debugging.

FromDataSimple is not only for debugging. The implementations for String and Vec<u8> are only for debugging, and it's a coincidence that they both implement FromDataSimple instead of FromData directly.

I guess we could copy the explanation to the page for FromDataSimple, but I would personally rather remove those implementations entirely in favor of an approach like #990.

@jebrosen jebrosen added the docs Improvements or additions to documentation label Nov 24, 2019
@SergioBenitez SergioBenitez added the no bug The reported bug was confirmed nonexistent label Feb 16, 2020
@SergioBenitez
Copy link
Member

Closing as invalid. I agree that we should expose safer, harder-to-lead-to-DoS APIs for Data. I would also like to rename FromDataSimple to FromData, and FromData to FromTransformedData, to better explain the differences.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation no bug The reported bug was confirmed nonexistent
Projects
None yet
Development

No branches or pull requests

3 participants