FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Docs: Add details related to testing in docs by kmr-srbh · Pull Request #2596 · lcompilers/lpython · GitHub

/ lpython Public

Docs: Add details related to testing in docs - #2596

Draft
kmr-srbh wants to merge 4 commits into
lcompilers:mainfrom
kmr-srbh:docs-enhancement
ConversationCommits (4)ChecksFiles changed
Draft

Docs: Add details related to testing in docs#2596
kmr-srbh wants to merge 4 commits into
lcompilers:mainfrom
kmr-srbh:docs-enhancement

Conversation

kmr-srbh commented Mar 11, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor

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:

  • Add details about the various types of tests, where they are located and why they are required.
  • Add details about the procedure to write integration tests and update references.
  • Add details about the procedure to write error tests and update references.

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

Planned:

  • Add details on compile time tests and their requirement. (guidance required)
  • Add details on troubleshooting failing CI tests.

kmr-srbh commented Mar 11, 2024

Copy link
Copy Markdown
Contributor Author

@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 changed the title Add details related to testing in docs Docs: Add details related to testing in docs Mar 11, 2024
ubaidsk reviewed Mar 21, 2024
View reviewed changes

ubaidsk left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

It looks like there are many indentation changes. It is hard for me to see/understand what changes were made.

kmr-srbh commented Mar 21, 2024

Copy link
Copy Markdown
Contributor Author

@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.

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

ubaidsk ubaidsk left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

Back | FazBrowse Home | New Git URL