capstone-engine / capstone

Capstone disassembly/disassembler framework for ARM, ARM64 (ARMv8), Alpha, BPF, Ethereum VM, HPPA, LoongArch, M68K, M680X, Mips, MOS65XX, PPC, RISC-V(rv32G/rv64G), SH, Sparc, SystemZ, TMS320C64X, TriCore, Webassembly, XCore and X86.
http://www.capstone-engine.org
7.61k stars 1.56k forks source link

Weaken requirements to document functions. #2324

Closed Rot127 closed 7 months ago

Rot127 commented 7 months ago

Your checklist for this pull request

Detailed description

In the last few PRs, people deleted (part) of the PR template and I assume it is because of the strict requirement for documentation. But to require from contributers to document functions which they barely looked at (because most changes are very small and rarely big PRs with a lot of code logic) is too much to ask IMHO. Such a task could sometimes easily be its own PR.

Most non-API functions are not even documented and a lot of modules get refactored to auto-sync in the future anyways. And with these refactors we should document the non-API functions and not load out this task to random contributers.

Test plan

Github md preview

Closing issues

None

Rot127 commented 7 months ago

@kabeor This is a small one, please check it.