Skip to content

Improve documentation#1

Merged
jmpavlick merged 3 commits into
jmpavlick:masterfrom
jfmengels:docs
Jan 11, 2025
Merged

Improve documentation#1
jmpavlick merged 3 commits into
jmpavlick:masterfrom
jfmengels:docs

Conversation

@jfmengels
Copy link
Copy Markdown
Contributor

@jfmengels jfmengels commented Jan 6, 2025

My obligatory "fixing docs while going through docs" PR. Hope this helps a bit. Feel free to take/discard what you want.

I also suggest you add a link to https://package.elm-lang.org/packages/jmpavlick/q/latest/ for this repo on GitHub.

I don't use X anymore, linking to GitHub is more appropriate.
@jfmengels
Copy link
Copy Markdown
Contributor Author

Also, no elm-review?! I'll let you do that 😄

elm-review init --template jfmengels/elm-review-config/package

@jfmengels
Copy link
Copy Markdown
Contributor Author

While I'm at it, I recommend that in the docs for A/Q/S, you use qualified imports, so A.qq instead of qq. That is less confusing.

Comment thread README.md
- Two lowercase `q`s to represent the optional maps

It's basically just syntactic sugar around `Maybe.andThen`; and unlike other cursed things that I hold near and dear to my heart, [@jfmengels](https://x.com/jfmengels) doesn't have an `elm-review` rule against it _yet_.
It's basically just syntactic sugar around `Maybe.andThen`; and unlike other cursed things that I hold near and dear to my heart, [@jfmengels](https://github.com/jfmengels/) doesn't have an `elm-review` rule against it _yet_.
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

based

Copy link
Copy Markdown
Owner

@jmpavlick jmpavlick left a comment

Choose a reason for hiding this comment

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

Damn dude, thank you so much!! Totally unexpected, but thank you for taking the time to tidy this up!

@jmpavlick jmpavlick merged commit 7a5f3e8 into jmpavlick:master Jan 11, 2025
@jmpavlick
Copy link
Copy Markdown
Owner

Also, no elm-review?! I'll let you do that 😄

elm-review init --template jfmengels/elm-review-config/package

Strange enough - this is actually not working for me at the moment:

$ elm-review
(node:80967) [DEP0174] DeprecationWarning: Calling promisify on a function that returns a Promise is likely a mistake.
(Use `node --trace-deprecation ...` to show where the warning was created)
-- CONFIGURATION COMPILATION ERROR ---------------------------------------------

Errors occurred while compiling your configuration for elm-review. I need your
configuration to compile in order to know how to analyze your files. Hopefully
the compiler error below will help you figure out how to fix it.

-- INCOMPATIBLE DEPENDENCIES ------------------------------------------ elm.json
                                                                                
The dependencies in your elm.json are not compatible.
               
Did you change them by hand? Try to change it back! It is much more reliable to
add dependencies with elm install or the dependency management tool in        
elm reactor.                                      

Please ask for help on the community forums if you try those paths and are still
having problems!

However, when I ran elm-review init and manually installed packages, everything worked just fine.

I pushed up a branch for you: #2 Perhaps I'm holding it wrong? I figure, the least I can do give you a SSCCE.

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.

2 participants