Skip to content

Improve code format #9781

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

Closed
wants to merge 89 commits into from
Closed

Improve code format #9781

wants to merge 89 commits into from

Conversation

TENIOS
Copy link
Contributor

@TENIOS TENIOS commented Jul 19, 2024

When I was updating markdown for tables (#9778) I noticed that the files with the new packages contain updated formatting of code blocks. They look better than the old ones because they have syntax highlighting, so you can immediately see any errors or incorrect indentation.

That's why I decided to reformat old code blocks with new ones while fixing both major errors and minor ones (absences, brackets, etc.). For example, you may find an unformatted block of code on the Prompts (link with anchor) page:

Prompts

I understand and realize the significance of these changes, so I made them manually (no joke) not using macros or RegEx (it took me a day).

I realize that it will be difficult to test all the changes, but I would ask you to treat this as a new step in writing documentation.

You can see the changes without diff in my fork repo or using the command in the laravel.com repository:

git clone --single-branch --branch "improve-code-format" https://github.com/TENIOS/docs "resources/docs/11.x"

P.S.: unfortunately English is not my native language so it is difficult for me to describe everything correctly and clearly.

@TENIOS TENIOS marked this pull request as ready for review July 19, 2024 17:16
@TENIOS
Copy link
Contributor Author

TENIOS commented Jul 19, 2024

By the way when I was doing tag design I found a second link tag, I checked and it is not used anywhere. Is this an echo of the past or just a typo? Either way I deleted it.

https://github.com/laravel/docs/blob/11.x/routing.md?plain=1#L556

@taylorotwell taylorotwell marked this pull request as draft July 22, 2024 14:34
@TENIOS
Copy link
Contributor Author

TENIOS commented Jul 22, 2024

Updated to the branch.

@TENIOS TENIOS marked this pull request as ready for review July 22, 2024 17:12
@taylorotwell taylorotwell marked this pull request as draft July 24, 2024 15:56
@taylorotwell
Copy link
Member

It will be a long time before I have time to review every code block for accuracy, if ever. 😕

@spcbfr
Copy link
Contributor

spcbfr commented Jul 26, 2024

@TENIOS I'd suggest maybe splitting this PR into 3 or 4 smaller PRs. each one dealing with a specific problem. syntax highlighting, wrong number of tabs and missing code blocks seem to be the 3 main contenders

@TENIOS
Copy link
Contributor Author

TENIOS commented Jul 26, 2024

@TENIOS I'd suggest maybe splitting this PR into 3 or 4 smaller PRs. each one dealing with a specific problem. syntax highlighting, wrong number of tabs and missing code blocks seem to be the 3 main contenders

After Tylor's words, I have my doubts about whether this PR has any place at all. I'm sorry about that, but my attempt had a place.

@TENIOS
Copy link
Contributor Author

TENIOS commented Jul 26, 2024

I have to close this PR because the changes come too often and constantly updating them until they are verified would not be the best way to go. I will make a couple of separate PRs to fix the bugs I found in the documentation and maybe publish the changed code blocks as separate files.

@TENIOS TENIOS closed this Jul 26, 2024
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