ansys / ansys/pyhps-data-transfer

Doc fixes for Examples section

Open
#217 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
0
Forks
0
Avg merge
1d 11h
Merged PRs (30d)
7

Description

I put the 00 and 01 prefixes in the file names of the examples in the first examples section in an attempt to reorder them so that the "Run file operations synchronously" was first and "Run file operations asynchronously" was second. However, this did not reorder them. If I was correct in assuming that this would be the preferred order, please make whatever changes are necessary to accomplish this.

Also, it seems odd to me that so many sections only have one example. If new examples aren't to be added soon, possibly come up with ways of grouping them?

Contributor guide

Open the contributing guide

Research direction

Inspect the first Examples section and its example filenames, especially the 00 and 01 prefixes, to determine how the displayed order is generated. Verify the rendered order after any documentation changes, and assess whether the single-example sections have a clear grouping approach; done means the ordering is correct and the section organization is explicitly improved or documented.

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
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.