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

Update documentation to reflect change in convention #9

Closed
wants to merge 2 commits into from

Conversation

vpfeiffer
Copy link
Contributor

The convention has changed to use final instead of self and prev instead of super.
This new convention is much easier to understand especially for users that are new to Nix and Nixpkgs.
This change is notable in the Nixpkgs project code.
I added a note mentioning that the official documentation hasn't been update with this information.
The documentation is currently undergoing an overhaul and that is why I believe this hasn't been reflected in
the nixpkgs documentation as of yet.

This is the new convention and has replaces self and super.
@vpfeiffer
Copy link
Contributor Author

vpfeiffer commented Oct 4, 2022

I realized I missed that there are some examples in the nixpkgs documentation that use final and prev but just not in the overlays section yet.

@tazjin
Copy link
Owner

tazjin commented Oct 4, 2022

Hey, thanks for the PR!

I've imported it into the TVL Gerrit here (with some minor formatting fixes): https://cl.tvl.fyi/c/depot/+/6859/

(Note that this Github repo is just a split out of TVL's actual monorepo).

As for the change itself, I'm going to ask some of our contributors that are more active nixpkgs contributors than myself to review, as I'm afraid I am not up-to-date with most of the convention changes happening at the moment :)

@tazjin
Copy link
Owner

tazjin commented Oct 4, 2022

Going to close this PR as the review flow is on Gerrit. Note that you can log in there with your Github account and comment, if something comes up!

@tazjin tazjin closed this Oct 4, 2022
@vpfeiffer
Copy link
Contributor Author

No problem! I wanted to add the second comment I mentioned above to the issue in Gerrit but there was an unexpected error when I attempted to sign in with my GH credentials. I'll try again later.

@tazjin
Copy link
Owner

tazjin commented Oct 4, 2022

Oh that's very strange, I've filed an issue on our side for that so someone can look at the logs. Thanks so much for letting me know!

(If that someone ends up being me it'll unfortunately have to wait until tomorrow, I caught a cold 🤒)

@vpfeiffer
Copy link
Contributor Author

Feel better!

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.

None yet

2 participants