search

contao / docs-archive

Contao Documentation
https://docs.contao.org/
Other
42 stars 76 forks source link

add prepareFormData to api documentation #303

Closed bezin closed 9 years ago

bezin commented 9 years ago

Actually just porting that stuff from the 3.2 manual to the new api documentation. I added a tiny usecase example as well.

lionel-m commented 9 years ago

Hi @bezin, Could you use ATX style headlines (e.g. # H1 or ### H3)

bezin commented 9 years ago

Hmm, I used the storeFormData hook as a template and as far as I see all the hooks are documented like that?

lionel-m commented 9 years ago

Yes but these files will be modified to follow the general rules in the contributing file.

fiedsch commented 9 years ago

I've got the script to convert the files ready (https://gist.github.com/fiedsch/9a76e2410202ff4b30c7) but did not apply it yet. How can I avoid that the changed files would be included in my open pull request #302. Create a new branch? I don't want to mess things again :-(

bezin commented 9 years ago

@lionel-m allright, that's good to know. I modified my headline styles and word break according to the guidelines.

aschempp commented 9 years ago

@bezin thanks for the work! Please also update the hooks.md document to link to this new documentation.

@fiedsch do you mean merging this would affect your gist script? Or because of another rebase/merge?

aschempp commented 9 years ago

Please also update the hooks.md document to link to this new documentation.

Stupid me, I just noticed you already did that :D

fiedsch commented 9 years ago

@aschempp I'd apply the script to the files once you merged @bezin's PR after updating (rebasing) my repo. If the style is already ATX the script should simply do nothing. But I'll double check before creating any PR. One thing I have not found out yet: how do I separate this from my current PR? If I change files in my repo the changes become part of the current open PR. Do I have to create a new branch?

aschempp commented 9 years ago

yes you should alway create a new branch for anything you're working on. You don't have to wait for the PR to be merged, it's GITs job to merge both. Shouldn't be a problem because your PR won't affect the other file.

bezin commented 9 years ago

I needed to restructure my repo a little bit, sorry for the hassle. I open a new PR.