Skip to content
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

Add documentation for Not. #3045

Merged
merged 1 commit into from
Aug 16, 2023
Merged

Add documentation for Not. #3045

merged 1 commit into from
Aug 16, 2023

Conversation

mars0i
Copy link
Contributor

@mars0i mars0i commented Aug 15, 2023

Description

Add documentation for Not. Based on a suggestion by Andre in discord.

Should this change go in the CHANGELOG?

Yes, I think so.

  • If this is a fix, user-facing change, a compiler change, or a new paper
    implementation, I have updated CHANGELOG.md (and potentially also
    CONTRIBUTORS.md).

CHANGELOG.md Outdated
@@ -25,6 +25,7 @@
* Adds documentation for unquotes `~( )`.
* Adds documentation for laziness and codata primitives: `Lazy`, `Inf`, `Delay`,
and `Force`.
* Adds documentation for `Not`.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think, this line is added in the wrong section of the changelog. This section is for changes in REPL, and REPL has special functionality for showing documentation for syntax constructions, and this section is for such additions. You've added documentation to the source code, not to the REPL. I'm even not sure that your change should go into the changelog, since it just adds what should have been there.

Copy link
Contributor Author

@mars0i mars0i Aug 15, 2023

Choose a reason for hiding this comment

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

OK. I wasn't sure, but saw there were doc changes in the REPL section. I didn't see any other section for documentation. I can change the PR or withdraw it and make a new one (I think).

Copy link
Contributor

Choose a reason for hiding this comment

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

It's better to change this PR

@mars0i
Copy link
Contributor Author

mars0i commented Aug 15, 2023

I undid the changes to CHANGELOG.md and CONTRIBUTORS. I can squash the commits if you want it cleaned up a bit. Maybe that would make the conversation confusing. Probably doesn't matter either way.

@buzden
Copy link
Contributor

buzden commented Aug 15, 2023

I can squash the commits

Commits can usually be squashed by maintainers when merging the PR, so you can do this, but it can be done during the merge without additional steps from the PRs author.

@mars0i
Copy link
Contributor Author

mars0i commented Aug 15, 2023

OK, thanks @buzden. If it's easy for you to squash, I'm happy to let you do that. One time I made a mess of a PR before it was finally suitable, and was asked to clean it up before it would be accepted.

@buzden
Copy link
Contributor

buzden commented Aug 15, 2023

If it's easy for you to squash

It seems I've been excessively active on commenting the PR. I don't have rights to merge PRs, I'm just a regular contributor, I just lived here long enough to know some functionality ;-)

@mars0i
Copy link
Contributor Author

mars0i commented Aug 16, 2023

Squashed. And I assume that contrary to what I originally indicated, this should not go in the CHANGELOG.

@andrevidela andrevidela merged commit 86c53e6 into idris-lang:main Aug 16, 2023
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants