Conversation
|
Notes on the byte-compile warning and the package-lint errors. The warning when byte compiling comes from a case where I am trying to reduce the code size and thus am leaving out anything that is not minimally necessary to get the code to function (like calls to ignore). The package-lint errors are false positives. Both defuns in question are used temporarily in local variables and are otherwise in a quoted list. One is also included at top level, but it needs to retain a definition that is identical to the one used in the local variables since they are both derived from the same noweb block. |
|
From the travis error log. That's not something you want to see. |
|
No worries about Travis. A quick pass over the checklist: orgstrap.elbyte-compile (using Emacs 27.1): You can silence the warning about checkdoc (using version 0.6.2):
package-lint (using version 20200901.2204): Other possible lints:
|
|
@riscy Thank you very much for the review! I have pushed several updates.
All should be fixed now.
Should still be the case
So for this one I fixed the two warnings as suggested, and instead got 7 new warnings because I was
Thanks, fixed.
I made some major changes around this because they weren't really 0.1 and 0.2, they were really "portable" and "minimal." The thing that needed to be versioned doesn't actually need to be versioned and is the normalization procedure, which just needs to be differentiated. I still stick a version on there just for simplicity sake, but there will only ever be one of those in the codebase at a time.
I got rid of that unbinding, there was no reason to do it. I also moved all of the code inside function definitions so that it really is constant and cannot be easily changed. This is because that code is used to populate local variables and it needs to be tightly controlled since it is run via an eval local variable. In almost all cases it is deduplicated using noweb in the source in README.org. Also darn! You caught my attempt to enforce safe code execution defaults on users! I have fixed it by storing the original value and restoring it in the unwind forms.
Axed all of those. They were an overly complicated brainstorming exercise.
Done. I nearly always write it out as when not because my brain refuses to grok unless yet has no issue with when not, and then I forget to change it to unless.
Done. I should have known to do it since I have been promulgating the use of spdx for licenses amongst my colleagues for years (derp). |
|
Thanks for accommodating!
We can mark those as false positives now -- this looks like the right approach to me. While here I'll note it can be safer for your refactoring efforts (renaming functions, etc.) if you use a sharp-quote in your defaliases -- then the byte-compiler will warn you when the functions don't exist:
This is fair, and it's definitely not a blocker - I'll actually try to soften the language around that "lint". In ruby for example I don't use unless for similar reasons to you, but in lisps it removes one level of nesting which is sometimes a (small) benefit.
For what it's worth, I primarily see SPDX licenses written as All that said, welcome to MELPA! |
|
I made the changes to use the sharp form for aliases, I had wondered about whether that could be done before, but had never actually seen it used, so good to know there are benefits! For whatever reason I haven't figured out which tool produces the output with the warnings thought. I think reminding about Glad to be here. Thanks! |
Brief summary of what the package does
orgstrap is a specification and tools for standalone self-bootstrapping org-mode files.
Direct link to the package repository
https://github.com/tgbugs/orgstrap
Your association with the package
Maintainer.
Relevant communications with the upstream package maintainer
Of course I know him. He's me!
Checklist
Please confirm with
x:M-x checkdocis happy with my docstrings