Node status enum starts with a false statement

Bug #1422823 reported by Christian Reis
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
MAAS
Fix Released
Low
Raphaël Badin

Bug Description

Does the below make sense?

class NODE_STATUS:
    """The vocabulary of a `Node`'s possible statuses."""
    # A node starts out as READY.
    DEFAULT = 0

Tags: doc trivial

Related branches

Revision history for this message
Christian Reis (kiko) wrote :

Oh, even wierder if I look deeper:

class NODE_STATUS:
    """The vocabulary of a `Node`'s possible statuses."""
    # A node starts out as READY.
    DEFAULT = 0

    #: The node has been created and has a system ID assigned to it.
    NEW = 0

Revision history for this message
Raphaël Badin (rvb) wrote :

DEFAULT is an "alias" for NEW (which makes sense). What doesn't make sense is the "# A node starts out as READY." sentence.

Changed in maas:
status: New → Triaged
importance: Undecided → Low
tags: added: doc
tags: added: trivial
Revision history for this message
Christian Reis (kiko) wrote :

Right, that's what I meant to imply with my comment. Could you fix this in a drive-by?

Changed in maas:
assignee: nobody → Raphaël Badin (rvb)
Revision history for this message
Christian Reis (kiko) wrote :

BTW, the node statuses aren't documented anywhere in the API docs, but the end-user of the API kind of needs to know them and the state machine, don't they?

Revision history for this message
Raphaël Badin (rvb) wrote :

> BTW, the node statuses aren't documented anywhere in the API docs, but the end-user of the API kind of needs to know them
> and the state machine, don't they?

True, this is the related to bug 1376144.

Revision history for this message
Raphaël Badin (rvb) wrote :

Actually, the statuses are documented: https://maas.ubuntu.com/docs/enum.html.

Maybe we could make this information more visible but that should probably be part of a general refactoring of the documentation.

Raphaël Badin (rvb)
Changed in maas:
status: Triaged → Fix Committed
Changed in maas:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.