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

Indicate properties of operators. #1698

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Indicate properties of operators. #1698

wants to merge 8 commits into from

Conversation

smimram
Copy link
Member

@smimram smimram commented Jun 17, 2021

It would be a good thing to indicate in the doc whether sources are

  • fallible or not
  • active or not
  • self-syncing or not
    I propose that we add this information for all operators. Since this is quite an intrusive change, I would like to first know: @toots do you agree with this proposal for implementing this?

After that we need to change all operators...

@smimram smimram requested a review from toots June 17, 2021 08:57
@toots
Copy link
Member

toots commented Jun 17, 2021

I agree with the proposal but with the following remarks:

  • We should also add clock_safe and perhaps rename it.
  • Fallible and active is statically true or false only
  • self_sync should be either true/false statically or true when active (active here meaning when the source is being used)

I understand that some of these sources have parameters to change these values but I believe they should be "default" values, indicating the default behavior the user can expect.

We should accompany this PR with a new page in the online doc that explains what these entries mean too. I'm down to write it.

@smimram
Copy link
Member Author

smimram commented Jun 17, 2021

Is it better now?

@toots
Copy link
Member

toots commented Jun 18, 2021

Is it better now?

Yes!

@toots
Copy link
Member

toots commented Jun 19, 2021

I'm working on this. I should have mentioned that those flags really mean something on sources. Not sure how to convey how operators work..

@smimram
Copy link
Member Author

smimram commented Jun 21, 2021

@toots I filled in the parameters I could, but I would need a serious review on this one: I am far from being sure that I filled everything correctly or that I did not miss something...

A way to review is

LIQ_FREI0R=false LIQ_LADSPA=false ./liquidsoap --no-stdlib --list-functions-md 

At the end of the doc of operators there is now something like

This function is passive, fallible, not self-syncing and clock-safe.

@smimram smimram marked this pull request as ready for review June 21, 2021 07:27
@toots
Copy link
Member

toots commented Jun 23, 2021

Will have a look shortly, thanks!

@stale
Copy link

stale bot commented Jan 8, 2022

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Jan 8, 2022
@smimram smimram removed the stale label Jan 12, 2022
@stale
Copy link

stale bot commented Aug 13, 2022

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Aug 13, 2022
@toots toots removed the stale label Aug 14, 2022
@toots
Copy link
Member

toots commented Aug 14, 2022

Sorry for the lack of response here. Still down to consider it once rebased.

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.

None yet

2 participants