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

Move world_format.txt to world_format.md and refactor #13504

Merged
merged 10 commits into from Nov 8, 2023

Conversation

Bituvo
Copy link
Contributor

@Bituvo Bituvo commented May 13, 2023

This PR moves world_format.txt to a Markdown file (like what happened with lua_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!

doc/world_format.md Outdated Show resolved Hide resolved
@Bituvo
Copy link
Contributor Author

Bituvo commented May 26, 2023

Resolved merge conflicts.

@Montandalar
Copy link
Contributor

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.

@Bituvo
Copy link
Contributor Author

Bituvo commented May 27, 2023

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.

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.

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.

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.

@rubenwardy
Copy link
Member

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

@rubenwardy rubenwardy added the Maintenance Tasks to keep the codebase and related parts in order, including architectural improvements label May 27, 2023
@Bituvo
Copy link
Contributor Author

Bituvo commented May 28, 2023

I'll delete it.

Copy link
Member

@srifqi srifqi left a 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.

doc/world_format.md Outdated Show resolved Hide resolved
doc/world_format.md Outdated Show resolved Hide resolved
@srifqi
Copy link
Member

srifqi commented Oct 24, 2023

Sorry for hitchhiking this PR. I added some small fixes to be included in these changes.

@Bituvo
Copy link
Contributor Author

Bituvo commented Oct 25, 2023

It would seem as though your changes broke the PR 😅

@srifqi
Copy link
Member

srifqi commented Oct 27, 2023

That is weird. It failed when installing dependencies, though, so the failure is not from this PR specifically.

@srifqi srifqi merged commit 80c4c26 into minetest:master Nov 8, 2023
11 of 12 checks passed
@Bituvo Bituvo deleted the world_format branch November 10, 2023 01:14
@Bituvo Bituvo restored the world_format branch November 10, 2023 01:15
@Bituvo Bituvo deleted the world_format branch November 10, 2023 01:15
@Bituvo Bituvo restored the world_format branch November 10, 2023 01:15
cx384 pushed a commit to cx384/minetest that referenced this pull request Dec 9, 2023
…3504)



Co-authored-by: Muhammad Rifqi Priyo Susanto <muhammadrifqipriyosusanto@gmail.com>
kawogi pushed a commit to kawogi/minetest that referenced this pull request Dec 19, 2023
…3504)



Co-authored-by: Muhammad Rifqi Priyo Susanto <muhammadrifqipriyosusanto@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@ Documentation Maintenance Tasks to keep the codebase and related parts in order, including architectural improvements >= Two approvals ✅ ✅
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants