Skip to content

[Sempahore] Added first round of documentation #14144

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

Merged
merged 1 commit into from
Oct 7, 2020

Conversation

lyrixx
Copy link
Member

@lyrixx lyrixx commented Aug 28, 2020

refs #14139

@lyrixx
Copy link
Member Author

lyrixx commented Aug 31, 2020

@noniagriconomie Thanks for your feedback. I have addressed them

@noniagriconomie
Copy link
Contributor

Top, just i do not understood the « new Redis() » part, can you explain? Thx

@andrew-demb
Copy link
Contributor

@noniagriconomie this class available with redis extension - https://github.com/phpredis/phpredis#classes-and-methods

@noniagriconomie
Copy link
Contributor

I see better thx

Copy link
Contributor

@noniagriconomie noniagriconomie left a comment

Choose a reason for hiding this comment

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

i just do not know if for the documentation it should be mentioned that the component is experimental for now in this version :)

@wouterj wouterj added this to the 5.2 milestone Oct 3, 2020
@wouterj
Copy link
Member

wouterj commented Oct 4, 2020

Hi @lyrixx! Thanks for providing a documentation PR.

In the docs, we're slowly migrating to focus on framework usage. This means that instead of writing component documentation, we write framework guides. Do you maybe have time to update this documentation to instead be in /semaphore.rst and focus on how to use the Semaphore component in the framework? (this probably means telling how to register specific services, as I can't find framework integration yet)

i just do not know if for the documentation it should be mentioned that the component is experimental for now in this version :)

Yes, that should be mentioned :) See the 5.0 version of the string documentation for an example:

.. versionadded:: 5.0
The String component was introduced in Symfony 5.0 as an
:doc:`experimental feature </contributing/code/experimental>`.

@xabbuh xabbuh changed the base branch from master to 5.x October 6, 2020 11:53
@javiereguiluz javiereguiluz merged commit 14386cb into symfony:5.x Oct 7, 2020
@javiereguiluz
Copy link
Member

Grégoire, thanks for contributing this feature and its docs too. This is now merged!

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

Successfully merging this pull request may close these issues.

6 participants