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

Document that v:resource.record is not to be used as generic record l… #1912

Merged
merged 2 commits into from
Sep 5, 2024

Conversation

cweiske
Copy link
Contributor

@cweiske cweiske commented Aug 19, 2024

…oader

Related: #960

It bit me today when using it in the backend preview with a disabled/hidden record :(

@@ -8,8 +8,11 @@ resource.record ViewHelper `<vhs:resource.record>`
==================================================


Generic FAL resource ViewHelper
Generic FAL resource ViewHelper.
Copy link
Member

Choose a reason for hiding this comment

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

Files in Documentation/ViewHelpers are auto-generated whenever a ViewHelper class file changes - these changes would be overwritten by that automation. The other change is fine (except the .rst file doesn't need to be changed, that's automated), but this one for v:resource.record needs to be added in the RecordViewHelper directly.

@cweiske
Copy link
Contributor Author

cweiske commented Sep 5, 2024

Fixed.

@NamelessCoder
Copy link
Member

Thanks! Reported problems with code style are totally unrelated, caused by yet another phpstan update upstream which again changed which issues are reported - this happens so damn frequently, I should probably nail the phpstan dependency to a specific version...

@cweiske
Copy link
Contributor Author

cweiske commented Sep 5, 2024

I once ranted on the pear-dev mailing list about each php_codesniffer update adding new rules that my code did not follow. It turned out I was using phpcs wrong and ran it without a coding style and all new rules were used. The correct way was to choose a coding style with a hard list of rules, and stick to it.
Maybe phpstan has something similar.

@cweiske cweiske closed this Sep 5, 2024
@cweiske cweiske deleted the record-doc branch September 5, 2024 10:30
@cweiske cweiske restored the record-doc branch September 5, 2024 10:31
@cweiske cweiske reopened this Sep 5, 2024
@NamelessCoder
Copy link
Member

Could be. Right now I'm using phpstan with just a level, which definitely changes the detection rules very frequently - PHPCS is being used with a standard, PSR2, which hasn't changed.

@NamelessCoder
Copy link
Member

If you pull dev-development and rebase this branch the checks should now pass. Or you can enable the "edits from maintainers" option and I'll take care of it for you ;)

@cweiske
Copy link
Contributor Author

cweiske commented Sep 5, 2024

I don't see the "edits from maintainers" option anywhere here :(
Probably because:

On user-owned forks, if you want to allow anyone with push access to the upstream repository to make changes to your pull request, select Allow edits from maintainers.

and I am hosting the vhs fork at my company's org account, not my personal one.

@NamelessCoder
Copy link
Member

and I am hosting the vhs fork at my company's org account, not my personal one.

That makes sense. No worries, we can work with this as long as you're OK with me asking you to rebase or make minor changes yourself every now and then!

@NamelessCoder NamelessCoder merged commit 8863735 into FluidTYPO3:development Sep 5, 2024
14 checks passed
@cweiske cweiske deleted the record-doc branch September 5, 2024 11:28
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