`log` shouldn't return the string that was logged

[cdepillabout]

Why does log return the string that was logged?

-- | Logs any string to the console. This basically saves you
-- | from writing `liftEff $ log x` everywhere.
log :: forall e. String -> Aff (console :: C.CONSOLE | e) String
log s = do
  liftEff $ C.log s
  return s

The log function from Control.Monad.Eff.Console that's being wrapped around returns Unit.

-- | Write a message to the console.
foreign import log :: forall eff. String -> Eff (console :: CONSOLE | eff) Unit

All of the places I'm using log, I don't want it to return a string. I realize I could write void $ log "error message", but I think most uses of log won't need the string returned. I think the type should be changed to this:

log :: forall e. String -> Aff (console :: C.CONSOLE | e) Unit

Are other people using log such that they want it to return the string that has been logged?

[jdegoes]

Good point. I think this is a holdover (perhaps?) from when log could debug any a, not just a string, so you could use it like, x <- log $ computeX, where it makes sense. But given that it can only log strings, that doesn't really hold anymore.

[cdepillabout]

@jdegoes That makes sense. I guess it was like Haskell's Debug.Trace.

[jdegoes]

PRs welcome. :)

[texastoland]

I'll try to tackle it. API needs updated to mirror Prelude too.

[garyb]

Can we re-export the CONSOLE effect from the module too, if you're making that change? 🙏

[texastoland]

Fixed in ae9c72f.