cogentcore / core

A free and open source framework for building powerful, fast, and elegant 2D and 3D apps that run on macOS, Windows, Linux, iOS, Android, and the Web with a single pure Go codebase, allowing you to Code Once, Run Everywhere.
http://cogentcore.org/core
BSD 3-Clause "New" or "Revised" License
1.31k stars 71 forks source link

Improve package and type naming #949

Closed kkoreilly closed 2 months ago

kkoreilly commented 2 months ago

One of the most longstanding complaints about Cogent Core by various people, including me, @ddkwork, and various Reddit and golang-nuts users has been the use of excessively short and semantically meaningless names, like ki, xe, gi, Idx, Fm, and par.

This PR, in combination with various commits before it, systematically removes almost all of these meaningless names. For example, ki has been renamed to tree, xe has been renamed to exec, gi has been renamed to core, Idx has been renamed to Index, Fm has been renamed to From, and par has been renamed to parent.

Because this PR renames many packages, types, and variables, it contains a colossal amount of breaking changes that can not be easily enumerated. All users of Cogent Core should reinstall the core tool (run go install cogentcore.org/core/cmd/core@main) and update their code wherever there are errors, using the files changed in this PR as a reference. I will update https://github.com/cogentcore/cogent and https://github.com/emer/emergent.