Skip to content

Conversation

@enetheru
Copy link
Collaborator

@enetheru enetheru commented Mar 1, 2025

While I'm doing some tidying up I have these comment changes I'd like to make.

Because this PR is based on the GODOTCPP_ rename it wil have some of that intermingled in the change list, but it isnt in the actual changes of the PR.

There is a method to the madness, I aim for 80 column width for no real reason.

Top of the files get a restructures text comment with information about the file that looks like this:

#[=======================================================================[.rst:
Title
-------

This is where all the content goes. etc.. In restructured text_ format.

.. _text :https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html

]=======================================================================]

Functions get a header like this:

#[=============================[ Function Name ]=============================]
#[[ Information about the function in here, the number of '=' each side of the
title must match ]]
function( function_name )
endfunction()

And inline comments like so:

# Short Comment
#[[ Long comment is long
lorem ipsum etc..
lorem ipsum etc..]]

@dsnopek
Copy link
Collaborator

dsnopek commented Mar 1, 2025

Seems fine! You're the maintainer of these files, so I'm fine with whatever format you prefer (so long as we aren't reformatting them super frequently)

@enetheru enetheru force-pushed the comments branch 2 times, most recently from 80994e8 to 788368b Compare March 2, 2025 02:53
@enetheru enetheru marked this pull request as ready for review March 2, 2025 02:54
@enetheru enetheru requested a review from a team as a code owner March 2, 2025 02:54
@dsnopek dsnopek added enhancement This is an enhancement on the current functionality cmake topic:buildsystem Related to the buildsystem or CI setup labels Mar 4, 2025
@dsnopek dsnopek added this to the 4.x milestone Mar 4, 2025
@dsnopek dsnopek added cherrypick:4.4 and removed enhancement This is an enhancement on the current functionality labels Mar 4, 2025
@dsnopek dsnopek merged commit a3f8921 into godotengine:master Mar 6, 2025
11 checks passed
@enetheru enetheru deleted the comments branch March 7, 2025 07:44
@dsnopek
Copy link
Collaborator

dsnopek commented Mar 17, 2025

Cherry-picked for 4.4 in PR #1745

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cmake topic:buildsystem Related to the buildsystem or CI setup

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants