Skip to content

Commit

Permalink
chore(nns): Modify the comment on `include_empty_neurons_readable_by_…
Browse files Browse the repository at this point in the history
…caller` (#3740)

After changing the default value in a previous
[PR](#3612), the comment on the field
should also be updated.
  • Loading branch information
jasonz-dfinity authored Feb 4, 2025
1 parent 3afdf37 commit fd7cd5a
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions rs/nns/governance/api/src/ic_nns_governance.pb.v1.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3496,10 +3496,9 @@ pub struct ListNeurons {
pub include_neurons_readable_by_caller: bool,
/// Whether to also include empty neurons readable by the caller. This field only has an effect
/// when `include_neurons_readable_by_caller` is true. If a neuron's id already exists in the
/// `neuron_ids` field, then the neuron will be included in the response regardless of the value of
/// this field. Since the previous behavior was to always include empty neurons readable by caller,
/// if this field is not provided, it defaults to true, in order to maintain backwards
/// compatibility. Here, being "empty" means 0 stake, 0 maturity and 0 staked maturity.
/// `neuron_ids` field, then the neuron will be included in the response regardless of the value
/// of this field. The default value is false (i.e. `None` is treated as `Some(false)`). Here,
/// being "empty" means 0 stake, 0 maturity and 0 staked maturity.
#[prost(bool, optional, tag = "3")]
pub include_empty_neurons_readable_by_caller: Option<bool>,
/// If this is set to true, and a neuron in the "requested list" has its
Expand Down

0 comments on commit fd7cd5a

Please sign in to comment.