Skip to content

Commit 451f6ec

Browse files
author
Angel Campoverde
committed
Documenting old <-> new naming functions
1 parent 6f007de commit 451f6ec

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

doc/nicknames.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,14 @@ literal = aput.read_decay_name(event_type=event_type, style='literal')
1313
# To get representation with special symbols like "," or "-" replaced
1414
safe_1 = aput.read_decay_name(event_type=event_type, style= 'safe_1')
1515

16-
# To get event type back from nickname, only safe_1 implemented for now
17-
event_type = aput.read_event_type(nickname=nickname, style= 'safe_1')
16+
# To get event type back from nickname, nickname HAS to be safe_1
17+
event_type = aput.read_event_type(nickname=nickname)
18+
19+
# To get old nickname from new, nickname HAS to be safe_1
20+
old_nickname = aput.old_from_new_nick(nickname=nickname)
21+
22+
# To get new nickname from old, nickname is formatted by default as safe_1
23+
new_nickname = aput.new_from_old_nick(nickname=nickname, style='safe_1')
1824
```
1925

2026
### Update table with nicknames and event types

0 commit comments

Comments
 (0)