glog VS docs.rs

I started a poll on r/golang with these four candidates, but also came to know about glog which was a go port of a C++ project by Google. I used that option in the poll conducted on LinkedIn.

Other than print and formatted print to stdout and stderr, what more do you need? I adapted much of the glog rationale into a logging wrapper. Allowing many thousands of unneeded lines from Logrus to be avoided. https://github.com/golang/glog

check out glog, it supports flags out out the box

By globals, I mean global resources outside of the codes namespace. It may not even be a resource in the process, such as a log file or temporary directory or a database. If you have two versions of a crate in their completely separate worlds, and call both of their init_logging() functions to log to a file specified by an environment variable, things are likely to go pear shaped when they stomp over each others log file.

I'm a Rust novice, but the example I tripped over in Go was https://github.com/golang/glog. It has a module level init() initialization routine that makes calls to the stdlib flags package, manipulating the default command line flags (a global resource). If you ended up with multiple versions of glog via transient dependencies, your program would panic on startup as the second version's init() would make calls only allowed to be called once. Rust thankfully avoids this particular one by requiring initialization to be called by main() (apart from the hack described in the article).

There is no better way than looking at your older brothers and learning from them: stdlib log, glog, logrus, zerolog, log15 (eth fork)...

Also glog is the name of Google logging library which is confusing. https://github.com/golang/glog

the 5th hit looks like something made 6-8 yrs ago which would have worked: https://github.com/golang/glog

Read similar repos, compare, learn: https://github.com/rs/zerolog https://christine.website/blog/ln-the-natural-logger-2020-10-17 https://github.com/sirupsen/logrus https://github.com/golang/glog https://github.com/nikandfor/tlog (this one is mine)

Working in combination with CodeWhisperer in your IDE, you can send whole code sections to Amazon Q and ask for an explanation of what the selected code does. To show how this works, we open up the file.rs file cloned from this GitHub repository. This is part of an open source project to host documentation of crates for the Rust Programming Language, which is a language we are not familiar with.

Looks like a great initiative – I wish there was a reliable TS/JS equivalent of https://docs.rs (even considering rustdoc's deficiencies[1]).

I went through this exercise recently and so far my experience with trying to produce documentation from a somewhat convoluted TS codebase[2] has been disappointing. I would claim it's a consequence of the library's public (user-facing) API substantially differing from how the actual implementation is structured.

Typedoc produces bad results for that codebase so sphinx-js, which I wanted to use, doesn't have much to work with. I ultimately documented things by hand, for now, the way the API is meant to be used by the user.

Compare:

https://ts-results-es.readthedocs.io/en/latest/reference/api...

vs

https://tsdocs.dev/docs/ts-results-es/4.1.0-alpha.1/index.ht...

Rust Search Extension adds a section on docs.rs menubar which lists the features of a crate in a nice and easy to access format.

📝 Note: At the time of writing this post, I couldn't really locate the init function docs.rs documentation. It didn't seem easily accessible through any of the current HAL implementation documentation. Nevertheless, I reached the signature of the function through the source here.

Rust Crates are a Game-Changer 🎮:The ease of releasing a crate with `cargo publish` and the convenience of rolling out new versions amazed me. The auto-generated docs on Docs.rs. is an amazing tool, especially with docstring formatting. Doc tests serve as a two-fold tool for documenting the code and ensuring it's up-to-date.

I've found I manually type out certain subsets of URLs where possible[0], maybe that's subconsciously associated with my impression that Google Search results have gotten worse and worse over the years.

[0] https://en.wiktionary.org/wiki/ and https://docs.rs/ come to mind.

docs.rs also downloads you crate automatically to generate docs and I would guess lib.rs does something similar

There are also a few key sites you'll want to keep in your back pocket at all times: - The Standard Library Documentation has complete documentation for every std library function in Rust - crates.io is a repository for all third-party packages, and docs.rs has human-readable documentation for the overwhelming majority of them - The Rust Cookbook has some code examples for common tasks you may need to perform - Make sure you are using clippy, which is available through Rustup and can be run with cargo clippy as a replacement to cargo check, it adds additional lints for your Rust code and is very helpful for teaching many of the best practices

OTOH, source-code-generated-docs normalize how code docs are, like the rust docs.rs paradigm, so it sort of forces or encourages package creators/maintainers to write docs.