Skip to content

Refactoring part III #147

Closed
Closed

Description

@ufechner7
  • do not use untyped vectors like vertices = []
  • more consistant naming for v_a: In the moment we have _va, va, v_a and v_a_array
  • replace all occurances of array with either vector (1D) or matrix (2D). Not sure if we are using 3D arrays, I don't think so.

Activity

  1. added this to the Version 1.3 milestone on Mar 27, 2025
  2. 1-Bart-1 commented on Mar 27, 2025

    @1-Bart-1
    Member

    I like va, as it looks better in va_array, _va, etc.

  3. ufechner7 commented on Mar 27, 2025

    @ufechner7
    MemberAuthor

    I like va, as it looks better in va_array, _va, etc.

    The point is, they have different meanings, so we will need different names:

    1. norm of the apparent wind speed (scalar)
    2. apparent wind speed vector
    3. vector of the norm of the apparent wind speeds per panel

    My suggestion:

    1. va
    2. va_vec
    3. va_dist

    @jellepoland Any comment?

    Jelle wrote on Telegram:

    I guess one could assume that whoever interacts with code is smart enough to realize velocity is a vector, might also hold for other things.

    But then I do would prefer _arr, for consistency also with other lists of number and other code basis

    In Julia, Vector is the type used for 1D arrays and Matrix the type for 2D arrays. Therefore I suggest to use the suffix _vec for a 1D vector, which should also be changed everywhere else in the code.

  4. 1-Bart-1 commented on Mar 27, 2025

    @1-Bart-1
    Member

    We have talked about this before on telegram, as long as the naming is consistent everywhere your suggestions are fine.

  5. 1-Bart-1 commented on Sep 16, 2026

    @1-Bart-1
    Member

    @1-Bort-1 implement consistent and readable naming in this package.

  6. 1-Bort-1 commented on Sep 16, 2026

    @1-Bort-1
    Member

    This branch does the first box only: every untyped empty container (vertices = [], plots = [], ...) gets its element type, in src, the Makie extension, tests and an example. The two renames are stacked follow-ups: #336 (*_array → vector/matrix) and then #337 (one va convention, which starts by asking about the public va=/v_a= keywords).

  7. 1-Bort-1 commented on Sep 16, 2026

    @1-Bort-1
    Member

    First part (typed empty containers) is e971c74 on agent/147-refactoring-part-iii, whose PR opens with this turn. The two renames are queued as #336 (*_array) and #337 (va).

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

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions