Hangus-Udson / Hangus-Udson/doc-parser

Improvement of type descriptions

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

Description

Currently type descriptions are limited to the exact type specified in the C++ code. (e.g. uint64_t). To improve readability, such types should be converted into plain English equivalents as in here https://loki-project.github.io/loki-docs/Developer/DaemonRPCGuide/

I would propose designing some kind of HashMap that converts C++ types to plain English strings and running all types through it to spit out the better description.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.