PaddlePaddle / PaddlePaddle/docs

官网API文档部分节表现效果较差

Open
#6,063 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

PFCC
Dominant language
Python
Stars
284
Forks
906
PR merge metrics
No merged PRs in 30d

Description

文档链接&描述 Document Links & Description

例子:paddle.linalg.inv

使用本API的教程文档

Pytorch 写法
Pytorch 写法
PyTorch 写法:

请提出你的建议/提个PR修复这个问题 Please give your suggestion/update a PR to fix it

API 文档中的 “## 使用本API的教程文档” 表意不明,表现效果较差,这部分真有意义吗,因为我看到其非常混乱?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked paddle.linalg.inv API page and inspect the “使用本API的教程文档” section and its three linked PyTorch comparison pages. Determine whether the section should be clarified, reorganized, or removed, then apply the agreed treatment consistently to the affected API documentation and verify the rendered links and heading.

Written by the indexing model from the issue text.

Assessment

Tech stack
pytorch
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.