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

[BUG] setUpDocHeader example documentation outdated #3880

Open
calien666 opened this issue Jan 14, 2024 · 1 comment
Open

[BUG] setUpDocHeader example documentation outdated #3880

calien666 opened this issue Jan 14, 2024 · 1 comment

Comments

@calien666
Copy link
Contributor

Current behavior

Acutally, the best practice on Creating a backend module shows the setUpDocHeader method with $moduleTemplate as param.
https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ExtensionArchitecture/HowTo/BackendModule/CreateModule.html#main-entry-point

Below the example method has 2 disadvantages:

  1. the method name isn't the same as in the main entry point documented
  2. the praram is not the same as expected
    https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ExtensionArchitecture/HowTo/BackendModule/CreateModule.html#the-docheader

Expected behavior/output

A correct example, how to use setUpDocHeader with the $moduleTemplate.

TYPO3 versions

12 (and possibly main)

Possible Solution

I don't know, what is best practice there.

@linawolf
Copy link
Member

Thanks for reporting this @calien666. Could you provide a PR to improve the example?

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

No branches or pull requests

2 participants