deepmodeling
Docs: there are some information mismatch between the LTS version functionalities and online documents
Details
Recently, there are LTS version users reported in ABACUS QQ group that they got confused when reading the online documents, especially on the correspondence between output files and keywords controlling it.
out_mat_hs2: https://abacus.deepmodeling.com/en/latest/advanced/elec_properties/hs_matrix.html#out-mat-hs2, where there are only nomenclature of files of version later than approximately 3.9.0.4.
Have you read the online manual http://abacus.deepmodeling.com/en/latest/
- [x] Yes, I have read the online manual.
Task list for Issue attackers (only for developers)
- [ ] Identify the specific section of the documentation with the issue.
- [ ] Investigate the issue and determine the root cause.
- [ ] Research best practices and potential solutions for the identified issue.
- [ ] Update the documentation to address the issue, following the suggested improvement.
- [ ] Ensure the updated documentation adheres to the project's documentation standards.
- [ ] Test the updated documentation to ensure it is clear and accurate.
- [ ] Review and incorporate any relevant feedback from users or developers.
- [ ] Publish the updated documentation and notify the issue reporter.
For most keywords, we have documents for both LTS and develop versions. If users found discrepancies, please ask users to point out which keyword has caused confusion. Otherwise, thers is not practical ways to improve the online documents.
For most keywords, we have documents for both LTS and develop versions. If users found discrepancies, please ask users to point out which keyword has caused confusion. Otherwise, thers is not practical ways to improve the online documents.
@mohanchen got it, I will timely collect the discrepancies found by users and update this issue~