Skip to content

Commit

Permalink
chore: change TODO format to refer to github name (#255)
Browse files Browse the repository at this point in the history
  • Loading branch information
bkioshn authored Feb 19, 2024
1 parent 37851b0 commit 97f675a
Show file tree
Hide file tree
Showing 11 changed files with 18 additions and 17 deletions.
1 change: 1 addition & 0 deletions .config/dictionaries/project.dic
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ appspot
asyncio
asyncpg
auditability
bkioshn
bluefireteam
BROTLI
cardano
Expand Down
2 changes: 1 addition & 1 deletion catalyst-gateway/bin/src/event_db/queries/vit_ss/fund.rs
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ impl EventDB {

#[async_trait]
impl VitSSFundQueries for EventDB {
// TODO (SJ) : https://github.com/input-output-hk/catalyst-voices/issues/68
// TODO(stevenj): https://github.com/input-output-hk/catalyst-voices/issues/68
#[allow(clippy::too_many_lines)]
async fn get_fund(&self) -> Result<FundWithNext, Error> {
let conn = self.pool.get().await?;
Expand Down
2 changes: 1 addition & 1 deletion catalyst-gateway/bin/src/service/api/registration/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ impl RegistrationApi {
/// The Event ID to return results for.
/// See [GET Events](Link to events endpoint) for details on retrieving all valid
/// event IDs.
// TODO (Blue) : https://github.com/input-output-hk/catalyst-voices/issues/239
// TODO(bkioshn): https://github.com/input-output-hk/catalyst-voices/issues/239
#[oai(validator(minimum(value = "0"), maximum(value = "2147483647")))]
event_id: Query<Option<EventId>>,
/// If this optional flag is set, the response will include the delegator's list
Expand Down
2 changes: 1 addition & 1 deletion catalyst-gateway/bin/src/service/api/v1/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ impl V1Api {
&self,
/// Comma-separated list of fragment ids for which the statuses will
/// be retrieved.
// TODO (Blue) : https://github.com/input-output-hk/catalyst-voices/issues/239
// TODO(bkioshn): https://github.com/input-output-hk/catalyst-voices/issues/239
#[oai(validator(max_items = "1000"))]
Query(fragment_ids): Query<Vec<FragmentId>>,
) -> fragments_statuses::AllResponses {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ pub(crate) struct AccountVote {
/// The hex-encoded ID of the vote plan.
pub(crate) vote_plan_id: VotePlanId,
/// Array of the proposal numbers voted for by the account ID within the vote plan.
// TODO (Blue) : https://github.com/input-output-hk/catalyst-voices/issues/239
// TODO(bkioshn): https://github.com/input-output-hk/catalyst-voices/issues/239
#[oai(validator(max_items = "500", minimum(value = "0"), maximum(value = "255")))]
pub(crate) votes: Vec<u8>,
}
Expand Down
4 changes: 2 additions & 2 deletions catalyst-gateway/bin/src/service/common/objects/block.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ pub(crate) struct Slot(pub u32);
/// Block time defined as the pair (epoch, slot).
pub(crate) struct BlockDate {
/// Block's epoch.
// TODO (Blue) : https://github.com/input-output-hk/catalyst-voices/issues/239
// TODO(bkioshn): https://github.com/input-output-hk/catalyst-voices/issues/239
#[oai(validator(minimum(value = "0"), maximum(value = "4294967295")))]
pub epoch: Epoch,
/// Block's slot number.
// TODO (Blue) : https://github.com/input-output-hk/catalyst-voices/issues/239
// TODO(bkioshn): https://github.com/input-output-hk/catalyst-voices/issues/239
#[oai(validator(minimum(value = "0"), maximum(value = "4294967295")))]
pub slot_id: Slot,
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ pub(crate) struct StatusPending;
pub(crate) struct StatusRejected {
/// Reason the fragment was rejected.
// Should start with capital letter.
// TODO (Blue) : https://github.com/input-output-hk/catalyst-voices/issues/239
// TODO(bkioshn): https://github.com/input-output-hk/catalyst-voices/issues/239
#[oai(validator(max_length = "250", pattern = r"^[A-Z].*$"))]
pub reason: String,
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ pub(crate) struct FragmentsBatch {
/// stopped after the first error occurs.
pub fail_fast: bool,
/// Array of hex-encoded fragments bytes.
// TODO (Blue) : https://github.com/input-output-hk/catalyst-voices/issues/239
// TODO(bkioshn): https://github.com/input-output-hk/catalyst-voices/issues/239
#[oai(validator(
max_items = "100",
max_length = 66,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ pub(crate) struct RejectedFragment {
/// future, this might change to including the prefix "0x".
fragment_id: FragmentId,
/// The number of the pool that caused this error.
// TODO (Blue) : https://github.com/input-output-hk/catalyst-voices/issues/239
// TODO(bkioshn): https://github.com/input-output-hk/catalyst-voices/issues/239
#[oai(validator(minimum(value = "0"), maximum(value = "4294967295")))]
pool_number: usize,
/// The reason why this fragment was rejected.
Expand All @@ -62,7 +62,7 @@ impl Example for RejectedFragment {
/// Information about whether a message was accepted or rejected.
pub(crate) struct FragmentsProcessingSummary {
/// IDs of accepted fragments.
// TODO (Blue) : https://github.com/input-output-hk/catalyst-voices/issues/239
// TODO(bkioshn): https://github.com/input-output-hk/catalyst-voices/issues/239
// Pattern: hex
#[oai(validator(
max_items = "100",
Expand All @@ -72,7 +72,7 @@ pub(crate) struct FragmentsProcessingSummary {
))]
accepted: Vec<FragmentId>,
/// Detailed information about rejected fragments.
// TODO (Blue) : https://github.com/input-output-hk/catalyst-voices/issues/239
// TODO(bkioshn): https://github.com/input-output-hk/catalyst-voices/issues/239
#[oai(validator(max_items = "100"))]
rejected: Vec<RejectedFragment>,
}
Expand Down
8 changes: 4 additions & 4 deletions catalyst-gateway/bin/src/service/common/objects/voter_info.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ use super::{delegate_public_key::DelegatePublicKey, voter_group_id::VoterGroupId
pub(crate) struct VoterInfo {
/// Voter's voting power.
/// This is the true voting power, subject to minimum voting power and max cap.
// TODO (Blue) : https://github.com/input-output-hk/catalyst-voices/issues/239
// TODO(bkioshn): https://github.com/input-output-hk/catalyst-voices/issues/239
#[oai(validator(minimum(value = "0"), maximum(value = "9223372036854775807")))]
voting_power: i64,

Expand All @@ -18,12 +18,12 @@ pub(crate) struct VoterInfo {

/// Total voting power delegated to this voter.
/// This is not capped and not subject to minimum voting power.
// TODO (Blue) : https://github.com/input-output-hk/catalyst-voices/issues/239
// TODO(bkioshn): https://github.com/input-output-hk/catalyst-voices/issues/239
#[oai(validator(minimum(value = "0"), maximum(value = "9223372036854775807")))]
delegations_power: i64,

/// Number of registration which delegated to this voter.
// TODO (Blue) : https://github.com/input-output-hk/catalyst-voices/issues/239
// TODO(bkioshn): https://github.com/input-output-hk/catalyst-voices/issues/239
#[oai(validator(minimum(value = "0"), maximum(value = "9223372036854775807")))]
delegations_count: i64,

Expand All @@ -36,7 +36,7 @@ pub(crate) struct VoterInfo {

/// List of stake public key addresses which delegated to this voting key.
#[oai(skip_serializing_if_is_none = true)]
// TODO (Blue) : https://github.com/input-output-hk/catalyst-voices/issues/239
// TODO(bkioshn): https://github.com/input-output-hk/catalyst-voices/issues/239
#[oai(validator(max_items = "100"))]
delegator_addresses: Option<Vec<DelegatePublicKey>>,
}
Expand Down
4 changes: 2 additions & 2 deletions catalyst-gateway/bin/src/service/common/responses/resp_5xx.rs
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@ struct ServerErrorPayload {
id: Uuid,
/// *Optional* SHORT Error message.
/// Will not contain sensitive information, internal details or backtraces.
// TODO (Blue) : https://github.com/input-output-hk/catalyst-voices/issues/239
// TODO(bkioshn): https://github.com/input-output-hk/catalyst-voices/issues/239
#[oai(validator(max_length = "100", pattern = "^[0-9a-zA-Z].*$"))]
msg: Option<String>,
/// A URL to report an issue.
// TODO (Blue) : https://github.com/input-output-hk/catalyst-voices/issues/239
// TODO(bkioshn): https://github.com/input-output-hk/catalyst-voices/issues/239
#[oai(validator(max_length = "1000"))]
issue: Option<Url>,
}
Expand Down

0 comments on commit 97f675a

Please sign in to comment.