Clarify key system

JuliaMolSim · Nov 2, 2024 · e198c28 · e198c28
1 parent 5795f0f
commit e198c28
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -24,3 +24,16 @@ identifier = "pd_nc_sr_lda_stringent_0.4.1_upf"
 library = PseudoLibrary(identifier)
 filename = pseudofile(library, :Si)
 ```
+
+For a list of available identifiers see
+```julia
+PseudoLibraries.available_identifiers()
+```
+More details on the meaning of these keys is given
+in the README of thei
+[PseudoLibrary](https://github.com/JuliaMolSim/PseudoLibrary/blob/7c4b71a3b9d70a229d757aa6d546ef22b83a85a9/README.md)
+repository.
+
+**Warning:**
+The current identifiers for the pseudopotential families is planned to be overhauled.
+This will be a breaking change, where the minor version of the package will be bumped.
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -53,10 +53,12 @@ For a list of available identifiers see
 PseudoLibraries.available_identifiers()
 ```
 More details on the meaning of these keys is given
-at [PseudoLibrary](https://github.com/JuliaMolSim/PseudoLibrary/blob/7c4b71a3b9d70a229d757aa6d546ef22b83a85a9/README.md).
+in the README of thei
+[PseudoLibrary](https://github.com/JuliaMolSim/PseudoLibrary/blob/7c4b71a3b9d70a229d757aa6d546ef22b83a85a9/README.md)
+repository.
 
-!!! warning "Rename of keys reserved"
-    The current system of identifying the pseudopotential families will change in the future.
+!!! warning "Rename of pseudopotential identifier reserved"
+    The current identifiers for the pseudopotential families is planned to be overhauled.
     This will be a breaking change, where the minor version of the package will be bumped.
 
 ## Interface