Skip to content

chore: Node tidy - #2525

Merged
trisyoungs merged 33 commits into
develop2from
dissolve2/node-tidy
Jun 24, 2026
Merged

chore: Node tidy#2525
trisyoungs merged 33 commits into
develop2from
dissolve2/node-tidy

Conversation

@trisyoungs

@trisyoungs trisyoungs commented Jun 22, 2026

Copy link
Copy Markdown
Member

It's a contender for most boring, unreviewable PR of 2026, but here is a Node-wide tidy up PR. The goal was to make all the node definitions consistent in terms of formatting, layout, commenting etc. Bit OCD, but it's done now! I have also removed commented code and a few other small bits of unused / irrelevant stuff here and there, and done a little bit of renaming, but nothing of note.

All the Nodes now look like this:

class MyNode : public Node
{
    public:
    MyNode(Graph *parentGraph);
    ~MyNode() override = default;

    /*
     * Definition
     */
    public:
    // Return type of the node
    std::string_view type() const override;
    // Return short summary of the node's purpose
    std::string_view summary() const override;

    /*
     * Data
     */
    private:
    /* Specific inputs, options, outputs, and data generated by the node

    public:
    // Clear any local data
    void clearData() override;      /* If required, typically analysis nodes, plus GR, SQ etc. */

    /*
     * Processing
     */
    private:
    /* Local functions implemented by the node */

    protected:
    // Perform processing
    NodeConstants::ProcessResult process() override;
};

@trisyoungs
trisyoungs requested a review from rprospero June 22, 2026 14:34

@RobBuchananCompPhys RobBuchananCompPhys left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very cool, glad to see those nodes broken out of sub-dirs too!

@trisyoungs
trisyoungs merged commit 18c6adc into develop2 Jun 24, 2026
8 of 9 checks passed
@trisyoungs
trisyoungs deleted the dissolve2/node-tidy branch June 24, 2026 10:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants