8000 Improve the SecurityFactoryInterface documentation · Issue #4705 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

Improve the SecurityFactoryInterface documentation #4705

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
Closed
xabbuh opened this issue Dec 29, 2014 · 3 comments
Closed

Improve the SecurityFactoryInterface documentation #4705

xabbuh opened this issue Dec 29, 2014 · 3 comments
Labels
Security

Comments

@xabbuh
Copy link
Member
xabbuh commented Dec 29, 2014

This was initially opened by @LangJ on the code repository in symfony/symfony#10870:

The methods of the SecurityFactoryInterface do not have any comments. It would be helpfull if there were comments describing how the methods should be implemented and how the are used.

http://symfony.com/doc/2.3/cookbook/security/custom_authentication_provider.html
is describing the Interface a bit, but especially the signature of the create method is unclear.
@rdohms
Copy link
Contributor
rdohms commented Apr 7, 2015

This interface needs at the very least a docblock to explain its return value, it gives absolutely no clue as to the implementation. Very sad to see the original bug report dismissed.

@cordoval
Copy link
Contributor
cordoval commented Apr 7, 2015

👍

@javiereguiluz
Copy link
Member

Closing as fixed because some comments were added to the code in symfony/symfony#18114 We won't add detailed explanations about methods and their signatures because we don't usually do that in the Symfony Docs (because that makes docs impossible to maintain). Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Security
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@javiereguiluz @rdohms @cordoval @xabbuh
0