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

remove redundant example for cat, update snapshot #1189

Merged
merged 5 commits into from
Sep 26, 2024

Conversation

kdiab
Copy link
Contributor

@kdiab kdiab commented Sep 21, 2024

This PR is for issue #1186

cat was documented twice causing it to appear twice in the API reference. This change removes the less descriptive example and keeps the other one.

image

@kdiab kdiab marked this pull request as draft September 21, 2024 03:48
@kdiab kdiab marked this pull request as ready for review September 21, 2024 03:50
@felixroos
Copy link
Collaborator

thanks for your contribution. It looks like this example you've removed is still referenced (as Pattern.cat) in https://strudel.cc/learn/factories/#cat , so maybe add it there as a MiniRepl instead?

@kdiab
Copy link
Contributor Author

kdiab commented Sep 21, 2024

Yeah I think that's a good idea! This looks more informative.

image

@kdiab
Copy link
Contributor Author

kdiab commented Sep 22, 2024

Found the same bug for seq and stack, going to combine with this PR.
image
image

@felixroos
Copy link
Collaborator

It looks like this example you've removed is still referenced (as Pattern.cat) in https://strudel.cc/learn/factories/#cat

have you looked at this? seq and stack might have refs as well

@kdiab
Copy link
Contributor Author

kdiab commented Sep 26, 2024

Yes! That's where I got the examples from 😊

@felixroos
Copy link
Collaborator

felixroos commented Sep 26, 2024

i mean have you checked if the factories page still looks as before? for example, this reference:

<JsDoc client:idle name="Pattern.seq" h={0} hideDescription />
just to double check

@kdiab
Copy link
Contributor Author

kdiab commented Sep 26, 2024

Oh I understand what you mean, yes that does seem to break the page, I will fix it.

@kdiab
Copy link
Contributor Author

kdiab commented Sep 26, 2024

Removed unnecessary instances of functions and fixed the factories folder.

image
image
image
image
image

@felixroos
Copy link
Collaborator

thanks, this now looks good!

@felixroos felixroos merged commit ad080d0 into tidalcycles:main Sep 26, 2024
1 check passed
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.

2 participants