JetBrains / JetBrains/Arend

Add documentation comments to Prelude.ard

Open
#293 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
Java
Stars
756
Forks
31
PR merge metrics
No merged PRs in 30d

Description

According to the language reference ([here](https://arend-lang.github.io/documentation/language-reference/prelude)), many declarations in Prelude are treated in a special way, they are not usual language constructs. It would be nice to have documentation comments right in the code to make that more explicit. The language reference is not always at hand, one could fail to find the necessary topics.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with Prelude.ard and compare its declarations with the linked language-reference page for Prelude. Add documentation comments where the reference describes special treatment, making those declarations' non-standard status explicit in the source. Done means the relevant special declarations are documented consistently in Prelude.ard.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.