Skip to content

Commit

Permalink
Make Type suffix a rule
Browse files Browse the repository at this point in the history
  • Loading branch information
jl-wynen committed Mar 11, 2024
1 parent b16ea24 commit 249c8c0
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/user-guide/reduction-workflow-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,15 @@ RunType = TypeVar('RunType', SampleRun, BackgroundRun)
class Filename(sciline.Scope[RunType, str], str): ...
```

### C.3: Use flexible types
### C.3: Use the suffix 'Type' for type vars

**Reason**
This makes it easier to distinguish type vars from concrete domain types.

**Example**
See 'RunType' and 'MonitorType' in the table of C.2.

### C.4: Use flexible types

**Reason**
Users should not have to worry about the concrete type of parameters.
Expand Down

0 comments on commit 249c8c0

Please sign in to comment.