Skip to content

Fix documentation minor mistake#1493

Merged
TomasVotruba merged 3 commits intorectorphp:masterfrom
alterphp:patch-1
May 29, 2019
Merged

Fix documentation minor mistake#1493
TomasVotruba merged 3 commits intorectorphp:masterfrom
alterphp:patch-1

Conversation

@alterphp
Copy link
Copy Markdown
Contributor

No description provided.

@JanMikes
Copy link
Copy Markdown
Contributor

@TomasVotruba isn't this file autogenerated? (It would mean typo in php code instead)

@TomasVotruba
Copy link
Copy Markdown
Member

@JanMikes Yes 👍

@alterphp Please fix it in this file:

public function someAction()
{
$this->getRequest()->...();
}
}
CODE_SAMPLE
,
<<<'CODE_SAMPLE'
use Symfony\Component\HttpFoundation\Request;
class SomeController
{
public action(Request $request)

Then regenarated docs with:

composer docs

And push, thank you 👍

@alterphp
Copy link
Copy Markdown
Contributor Author

@TomasVotruba As you see in 18ca7fb, there is a big diff in the generated doc files... That seems not good to me. WDYT ?

@TomasVotruba
Copy link
Copy Markdown
Member

TomasVotruba commented May 29, 2019

@alterphp Why not? It's the way generated files work.

There might be 1 new rule, or changed position, that influences the whole file.

Maybe if you use Windows/Mac, the sorting might be affected. But size in the end is ok, so it's ok.

@alterphp
Copy link
Copy Markdown
Contributor Author

Ok, if it's only a sorting difference, why not. I used the Docker image from the provided Dockerfile to dump them and I work on a Linux environment.

@TomasVotruba
Copy link
Copy Markdown
Member

TomasVotruba commented May 29, 2019

I see.

It's out of scope of this PR, I'm just curious. Is is better when you try adding sort here?

It should only change your line, there were no new rules since

@TomasVotruba TomasVotruba merged commit 3166323 into rectorphp:master May 29, 2019
@TomasVotruba
Copy link
Copy Markdown
Member

Thanks for the PR 👍

@alterphp
Copy link
Copy Markdown
Contributor Author

alterphp commented Jun 2, 2019

It's out of scope of this PR, I'm just curious. Is is better when you try adding sort here?

I tried many ways, still a big diff. Are you sure the generated doc in the master was up to date with source files ?

@TomasVotruba
Copy link
Copy Markdown
Member

Yes. The ordering is inconsistent, see: #1493 (comment)

I'll fix it, no troubles

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.

3 participants