search

rust-bakery / nom

Rust parser combinator framework
MIT License
9.18k stars 792 forks source link

Update nom_recipes /* C-style comments */ #1670

Closed red-swan closed 1 year ago

red-swan commented 1 year ago

The / C-style comments / section wouldn't work on my machine. Compiler error was very dense. I added a tuple to the three pieces of the parser and it works as signatured.

Xiretza commented 1 year ago

You're trying to use the examples from main for a 7.x nom. main has deprecated tuple() and updated the examples accordingly, you should be looking at the 7.x branch instead (or simply the docs.rs page for your version of nom).

epage commented 1 year ago

You're trying to use the examples from main for a 7.x nom.

I kept running into this with clap (didn't help how long v3 was unreleased) which is one of a couple of reasons which led me to integrating examples directly into docs.rs so they are versioned with the API reference and cross-linkable (example 1, example 2).

red-swan commented 1 year ago

Thanks @Xiretza for the reply. You're very busy so no need to answer this question: Why does main diverge from most up-to-date crate? Is there a reason you're not pushing breaking changes to another branch (e.g. v8.0.0-release-candidate)?

Xiretza commented 1 year ago

That's how @Geal does it, and in my experience it's a fairly common workflow. But of course the variety of git workflows is endless.

Geal commented 1 year ago

it is very common to have the main branch being the most up to date or in development version. I understand that sometimes this can cause confusion, though. In general, the documentation is the canonical source for a specific version, that's why I made sure to have the examples from the recipes available in the documentation, matching the relevant version: https://docs.rs/nom/7.1.3/nom/recipes/index.html#-c-style-comments-