10000 Some documentation fixes by fredrik-bakke · Pull Request #7065 · agda/agda · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Some documentation fixes #7065

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jan 23, 2024
Merged

Some documentation fixes #7065

merged 8 commits into from
Jan 23, 2024

Conversation

fredrik-bakke
Copy link
Contributor
@fredrik-bakke fredrik-bakke commented Jan 20, 2024

Summary

  • Add a remark about --cohesion not including the full set-up for cohesive homotopy type theory
  • Update lexical structure
    • The word Set is not a reserved keyword
    • The words opaque and unfolding are reserved keywords
    • The word as has special meaning in import statements
  • Update the list of doc/user-manual/language/safe-agda to be accurate and complete, based on unsafePragmaOptions and discussion I could find.
  • Make list of primitive sorts complete in doc/user-manual/language/built-ins, and remark on LevelUniv.
  • Fix some miscellaneous typos.
  • Add vscode workspace settings.

Remarks / Questions

  • The file .vscode/settings.json was added to .gitignore under the justification that the repository should not hold user settings, but this file is meant for repository-wide settings that help homogenize the contribution experience. For instance, the documentation seems to have a working line character limit of about 80 characters. This file allows you to add settings gently informing contributors about this with the setting
    "editor.rulers": [80]
  • The update to doc/user-manual/language/safe-agda leaves some justification missing. I would for instance love to know why --flat-split together with --without-K is disallowed. All the discussion I could find seemed to be about cubical. Also, I don't know what's up with --sized-types.

Apologies in advance if any of the changes are unwelcome!

Copy link
Member
@andreasabel andreasabel left a comment
8000

Choose a reason for hiding this comment

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

Thanks, great help!

Copy link
Member
@andreasabel andreasabel left a comment

Choose a reason for hiding this comment

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

Thanks!

@andreasabel andreasabel added ux: documentation Issues relating to Agda's documentation pr: squash-me This PR needs squashing labels Jan 23, 2024
@andreasabel andreasabel added this to the 2.6.4.2 milestone Jan 23, 2024
@fredrik-bakke
Copy link
Contributor Author

Glad I could contribute with something! 😄

@andreasabel andreasabel self-assigned this Jan 23, 2024
@andreasabel andreasabel merged commit a9c1763 into agda:master Jan 23, 2024
@fredrik-bakke fredrik-bakke deleted the doc branch January 23, 2024 22:48
@andreasabel andreasabel modified the milestones: 2.6.5, 2.6.4.2 Feb 8, 2024
andreasabel pushed a commit that referenced this pull request Feb 8, 2024
* documentation fixes `lexical-structure`

* documentation fixes `built-ins`

* misc typos

* add remark about chesion

* update `safe-agda`

* add vscode workspace settings

* double tick `as`

* review
@andreasabel andreasabel mentioned this pull request Feb 8, 2024
3 tasks
VitalyAnkh pushed a commit to VitalyAnkh/agda that referenced this pull request Mar 5, 2024
* documentation fixes `lexical-structure`

* documentation fixes `built-ins`

* misc typos

* add remark about chesion

* update `safe-agda`

* add vscode workspace settings

* double tick `as`

* review
VitalyAnkh pushed a commit to VitalyAnkh/agda that referenced this pull request Mar 5, 2024
JobPetrovcic pushed a commit to JobPetrovcic/agda that referenced this pull request Apr 12, 2024
* documentation fixes `lexical-structure`

* documentation fixes `built-ins`

* misc typos

* add remark about chesion

* update `safe-agda`

* add vscode workspace settings

* double tick `as`

* review
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr: squash-me This PR needs squashing ux: documentation Issues relating to Agda's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
0