Skip to content

[Code scan] Repository templates and docs contain stale dpdata metadata #1003

Description

@njzjz

This issue is part of a Codex global repository code scan.

Several user-facing repository metadata/docs entries appear stale or copied from another project, which can confuse issue reporters and documentation users.

Affected locations:

Bug report template still says deepmd-kit:

name: Bug report
description: Create a bug report to help us eliminate issues and improve deepmd-kit.
title: "[BUG] "

Feature request template asks users how they want to enhance deepmd-kit:

id: details
attributes:
label: Detailed Description
description: "Please explain how you would like to see deepmd-kit enhanced, what feature(s) you are looking for, what specific problems this will solve. If possible, provide references to relevant background information like publications or web pages, and whether you are planning to implement the enhancement yourself or would like to participate in the implementation. If applicable add a reference to an existing bug report or issue that this will address."

Docs hard-code version metadata as 0.0 / 0.0.0-rc even though package versioning is managed by setuptools_scm:

dpdata/docs/conf.py

Lines 31 to 34 in a7a50bf

version = "0.0"
# The full version, including alpha/beta/rc tags
release = "0.0.0-rc"

BondOrderSystem docs reference a misspelled/nonexistent sanitizer path:

The {class}`BondOrderSystem <dpdata.BondOrderSystem>` implements a more robust sanitize procedure for rdkit Mol, as defined in {class}`dpdata.rdkit.santizie.Sanitizer`. This class defines 3 level of sanitization process by: low, medium and high. (default is medium).

Expected behavior: issue templates should consistently refer to dpdata, docs should derive/display the current dpdata version, and docs references should point to the actual implementation path (dpdata.formats.rdkit.sanitize.Sanitizer).

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    Status
    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions