Skip to content

Commit ab49068

Browse files
0xLuccaeshaben
andauthored
Apply suggestions from code review
Co-authored-by: Erin Shaben <[email protected]>
1 parent 97d7888 commit ab49068

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

develop/parachains/deployment/manage-coretime.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -21,27 +21,27 @@ pub fn transfer<T: Config>(region_id: RegionId, new_owner: T::AccountId)
2121

2222
**Parameters:**
2323

24-
- **`origin`**: Must be a signed origin of the account which owns the region `region_id`
25-
- **`region_id`**: The region whose ownership should change
26-
- **`new_owner`**: The new owner for the region
24+
- **`origin`**: Must be a signed origin of the account which owns the region `region_id`.
25+
- **`region_id`**: The region whose ownership should change.
26+
- **`new_owner`**: The new owner for the region.
2727

2828
## Partition
2929

3030
Split a bulk coretime region into two non-overlapping regions at a specific time point. This operation divides a region temporally, creating two shorter regions that together span the same duration as the original.
3131

3232
The [partition](https://paritytech.github.io/polkadot-sdk/master/pallet_broker/pallet/struct.Pallet.html#method.partition){target=\_blank} operation removes the original region and creates two new regions with the same owner and core mask. The first new region spans from the original start time to the pivot point, while the second spans from the pivot point to the original end time.
3333

34-
This is useful when you want to use part of your allocated time immediately and reserve the remainder for later use, or when you want to sell or transfer only a portion of your time allocation.
34+
This is useful when you want to use part of your allocated time immediately and reserve the remainder for later use or when you want to sell or transfer only a portion of your time allocation.
3535

3636
```rust
3737
pub fn partition<T: Config>(region_id: RegionId, pivot: Timeslice)
3838
```
3939

4040
**Parameters:**
4141

42-
- **`origin`**: Must be a signed origin of the account which owns the region `region_id`
43-
- **`region_id`**: The region which should be partitioned into two non-overlapping regions
44-
- **`pivot`**: The offset in time into the region at which to make the split
42+
- **`origin`**: Must be a signed origin of the account which owns the region `region_id`.
43+
- **`region_id`**: The region which should be partitioned into two non-overlapping regions.
44+
- **`pivot`**: The offset in time into the region at which to make the split.
4545

4646
## Interlace
4747

@@ -57,28 +57,28 @@ pub fn interlace<T: Config>(region_id: RegionId, pivot: CoreMask)
5757

5858
Parameters:
5959

60-
- **`origin`**: Must be a signed origin of the account which owns the region `region_id`
61-
- **`region_id`**: The region which should become two interlaced regions of incomplete regularity
62-
- **`pivot`**: The interlace mask of one of the two new regions (the other is its partial complement)
60+
- **`origin`**: Must be a signed origin of the account which owns the region `region_id`.
61+
- **`region_id`**: The region which should become two interlaced regions of incomplete regularity.
62+
- **`pivot`**: The interlace mask of one of the two new regions (the other is its partial complement).
6363

6464
## Assign
6565

6666
[Assign](https://paritytech.github.io/polkadot-sdk/master/pallet_broker/pallet/struct.Pallet.html#method.assign){target=\_blank} a bulk coretime region to a specific task for execution.
6767

68-
This operation places an item in the workplan corresponding to the region's properties and assigns it to the target task. If the region's end time has already passed, the operation becomes a no-op. If the region's beginning has passed, it effectively starts from the next schedulable timeslice.
68+
This operation places an item in the work plan corresponding to the region's properties and assigns it to the target task. If the region's end time has already passed, the operation becomes a no-op. If the region's beginning has passed, it effectively starts from the next schedulable timeslice.
6969

70-
Use this operation to execute your tasks on the allocated cores. Choose final assignment when you're certain about the task allocation, or provisional when you might need flexibility for later changes.
70+
Use this operation to execute your tasks on the allocated cores. Choose a final assignment when you're certain about the task allocation or provisional when you might need flexibility for later changes.
7171

7272
```rust
7373
pub fn assign<T: Config>(region_id: RegionId, task: TaskId, finality: Finality)
7474
```
7575

7676
**Parameters:**
7777

78-
- **`origin`**: Must be a signed origin of the account which owns the region `region_id`
79-
- **`region_id`**: The region which should be assigned to the task
80-
- **`task`**: The task to assign
81-
- **`finality`**: Indication of whether this assignment is final or provisional
78+
- **`origin`**: Must be a signed origin of the account which owns the region `region_id`.
79+
- **`region_id`**: The region which should be assigned to the task.
80+
- **`task`**: The task to assign.
81+
- **`finality`**: Indication of whether this assignment is final or provisional.
8282

8383
## Pool
8484

@@ -94,7 +94,7 @@ pub fn pool<T: Config>(region_id: RegionId, payee: T::AccountId, finality: Final
9494

9595
**Parameters:**
9696

97-
- **`origin`**: Must be a signed origin of the account which owns the region `region_id`
98-
- **`region_id`**: The region which should be assigned to the pool
99-
- **`payee`**: The account which can collect revenue from the usage of this region
100-
- **`finality`**: Indication of whether this pool assignment is final or provisional
97+
- **`origin`**: Must be a signed origin of the account which owns the region `region_id`.
98+
- **`region_id`**: The region which should be assigned to the pool.
99+
- **`payee`**: The account which can collect revenue from the usage of this region.
100+
- **`finality`**: Indication of whether this pool assignment is final or provisional.

0 commit comments

Comments
 (0)