lcompilers / lpython

Python compiler
https://lpython.org/
Other
1.37k stars 157 forks source link

Docs: Add details related to testing in docs #2596

Open kmr-srbh opened 3 months ago

kmr-srbh commented 3 months ago

The problem

The current information related to testing is confusing and unclear. It does not guide one on what the various types of tests are and how to write and register them.

The fix

This PR does the following things:

Minor: Fix indentation in the README and installation docs for visual clarity.

Planned:

kmr-srbh commented 3 months ago

@Shaikh-Ubaid @Thirumalai-Shaktivel I request you to check this data and verify the correctness. I request you to provide me more information regarding compile time tests so that the section can be complete.

kmr-srbh commented 3 months ago

@Shaikh-Ubaid I request you to try the rich diff. In all, the indentation related to installation instructions were reduced; they are the same for the installation docs and the README. The section on testing was improved.