adobe / adobe/hyde

Be smarter about example files

Open
#7 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
340
Forks
45
PR merge metrics
No merged PRs in 30d

Description

Right now we permit example files to be included as siblings to the docs. (e.g., `connect.md` references `connect_example.cpp`.) These files are considered extraneous by the tool. We should permit all `.cpp` files in the output directories as long as they are start with the same name as a documentation file. Example:

```
m_connect.md // the doc file
m_connect_example.cpp // example file for connect. OK - do not flag.
m_foobar_example.cpp // example for a dead API, perhaps? Bad - should be flagged.
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.