ansys / ansys/scade-apitools

Modify the title of the examples.

Open
#34 1 comment 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
11
Forks
1
PR merge metrics
No merged PRs in 30d

Description

### Description of the modifications

Titles for the examples are based on package names or methods within a class for a particular package or module. Typically, titles for examples describe what the examples show you how to do. Changing the titles to be more description would be helpful.

### Useful links and references

_No response_

Contributor guide

Open the contributing guide

Research direction

Start by locating the example titles in the repository and reviewing how they are currently derived from package names or class methods. Update the titles so they describe what each example demonstrates, then verify that the examples and their documentation still present the intended descriptions.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.