Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 30, 2025

Docstrings across PaddleScience had mismatched parameter names, missing entries, or outdated types, causing confusion versus actual type hints and signatures.

  • Solver/Utils: Added missing parameters (ddp_model, delimiter, check_exist, decompress) to docstrings to mirror function signatures.
  • Geometry & Mesh: Synchronized sampling docstrings with actual arguments, documenting random options and criteria usage.
  • Datasets: Corrected parameter names and completeness (e.g., SEVIR event_idx, downsampling args, SyntheMol add_h, CGCNN distances).
  • Encoders/Decoders: Clarified forward method inputs/outputs for cuboid/extformer components and positional embedding helpers.
  • Experimental Math: Updated integration helpers to reflect integration_domains usage and result inputs.

Example:

def get_path_from_url(url, root_dir, md5sum=None, check_exist=True, decompress=True):
    """Download from given url to root_dir.

    Args:
        url (str): Download url
        root_dir (str): Root dir for downloading
        md5sum (str): md5 sum of download package
        check_exist (bool): Skip download if present and valid. Defaults to True.
        decompress (bool): Decompress tar/zip after download. Defaults to True.
    """
Original prompt

请帮忙修复PaddleScience中所有.py文件中的基础错误,比如

docstring中的参数类型和实际参数type hint没对齐
docstring中的参数名字和实际参数名字没对齐
docstring中的参数个数和实际参数个数没对齐


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@paddle-bot
Copy link

paddle-bot bot commented Dec 30, 2025

Thanks for your contribution!

Co-authored-by: HydrogenSulfate <23737287+HydrogenSulfate@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix mismatches in docstring parameter types and names Align docstring parameters with function signatures across PaddleScience Dec 30, 2025
@HydrogenSulfate HydrogenSulfate marked this pull request as ready for review December 31, 2025 03:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants