-
Notifications
You must be signed in to change notification settings - Fork 2k
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
Move world_format.txt
to world_format.md
and refactor
#13504
Conversation
Resolved merge conflicts. |
I would like to ask about the logic of leaving the .txt files behind. Personally I've taken to deleting the new lua_api.txt in my copy because it cripples the speed of tab completion. It's also my personal opinion that whitespace changes and touching files just to fix the vanity of code style is a waste of everybody's time, and often used for commit number/resume padding. That's my opinion and you're entitled to your own. |
That's what rubenwardy did when they switched the Lua API to Markdown (#12449), so I decided to stay consistent. I would assume that the pointer .txt files will be deleted at some point.
When a PR is merged, all of the changes in the forked branch are squashed into one. Each commit I've made for this branch will be combined into one, with the PRs title. Additionally, lots of people read the documentation when they are developing something for the engine, and readability and organization are very important parts of that. |
You don't need to add a new .txt for world_format, it's only needed for lua_api.txt as it's a highly linked to file |
I'll delete it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I found no major (content) changes from .txt
to .md
.
Two chapter links are also added.
Sorry for hitchhiking this PR. I added some small fixes to be included in these changes. |
It would seem as though your changes broke the PR 😅 |
That is weird. It failed when installing dependencies, though, so the failure is not from this PR specifically. |
…3504) Co-authored-by: Muhammad Rifqi Priyo Susanto <muhammadrifqipriyosusanto@gmail.com>
…3504) Co-authored-by: Muhammad Rifqi Priyo Susanto <muhammadrifqipriyosusanto@gmail.com>
This PR moves
world_format.txt
to a Markdown file (like what happened withlua_api.txt
) and completely refactors it. I believe it is a lot more readable and easy to add to now. If I got anything wrong, please let me know in a review!