Skip to content

docs lags behind the source code #7590

Description

@Cstandardlib

Details

Some PRs are making changes to input parameters & docs without following the instructions after v3.9.0.24, so the documentation lags behind the source code.

For example, assume_isolated added in #7354, sc_scan_steps in #7384 does not appear in the docs.

Have you read the online manual http://abacus.deepmodeling.com/en/latest/

  • 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.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions