Skip to content

Commit 0b7280c

Browse files
committed
Add alias resolution docs
1 parent 6905722 commit 0b7280c

File tree

3 files changed

+19
-3
lines changed

3 files changed

+19
-3
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,20 @@ More conservative manipulations are applied first. The first manipulation that r
4747

4848
### Resolution of aliases
4949

50-
Documentation for this will be added soon.
50+
When resolving aliases, the following steps are applied:
51+
52+
1. **Remove Conflicting Aliases**:
53+
Aliases that conflict with already approved symbols are removed. For example, if an alias maps to a symbol that is already approved, it is discarded to avoid conflicts.
54+
55+
2. **Correct Same Aliases**:
56+
If an alias maps to the same symbol as its original symbol, it is corrected and marked as an approved symbol. This ensures that aliases that are effectively the same as the original symbol are treated as valid.
57+
58+
3. **Handle Duplicate Aliases**:
59+
If multiple aliases map to the same original symbol:
60+
- By default, only one alias is retained, and the rest are discarded.
61+
- If the `keep_gene_multiple_aliases` option is enabled, all aliases are retained, and an identity mapping is created for the duplicates.
62+
63+
4. **Unaccepted Aliases**:
64+
Any aliases that cannot be resolved or conflict with the above rules are marked as unaccepted and excluded from the final results.
65+
66+
These steps ensure that aliases are resolved in a consistent and conflict-free manner, prioritizing approved symbols and avoiding ambiguity in the mapping process.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "hugo-unifier"
3-
version = "0.1.1"
3+
version = "0.1.2"
44
description = "Add your description here"
55
readme = "README.md"
66
authors = [

uv.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)