TeamREPENTOGON / TeamREPENTOGON/REPENTOGON

Better Callback Documentation

Open
#435 4 comments 0 reactions 1 assignee View on GitHub

@Syntax-Sculptor is already working on this.

Since May 2, 2024.

bug documentation
Dominant language
C++
Stars
345
Forks
51
Avg merge
11h 2m
Merged PRs (30d)
4

Description

While the callbacks page is a very useful resource for referencing what REPENTOGON has to offer, it has two faults:

  • When a callback's return type is a table, it is not stated most of the time whether it's an array or a dictionary.

  • Typos such as incorrect return types and missing parameters.

  • Could benefit from examples to onboard beginners.

  • Provide more examples

  • Fix return types and parameters

Contributor guide

No contributing guide indexed for this repository

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.