Skip to content

Commit

Permalink
Merge pull request #41 from scipp/remove-typevar-recommendation
Browse files Browse the repository at this point in the history
Replace strict type var naming convention
  • Loading branch information
SimonHeybrock authored Jun 24, 2024
2 parents 551bded + 5804213 commit b9a2c28
Showing 1 changed file with 3 additions and 6 deletions.
9 changes: 3 additions & 6 deletions docs/user-guide/reduction-workflow-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,13 +92,10 @@ RunType = TypeVar('RunType', SampleRun, BackgroundRun)
class Filename(sciline.Scope[RunType, str], str): ...
```

### C.3: Use the suffix 'Type' for type vars
### C.3: (Removed rule on naming TypeVars)

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

**Example**
See 'RunType' and 'MonitorType' in the table of C.2.
This guideline was too restrictive as not all TypeVars represent a "type", conceptually.
Instead, authors should apply good judgment when naming TypeVars.

### C.4: Use flexible types

Expand Down

0 comments on commit b9a2c28

Please sign in to comment.