Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Suggestion for revising documentation on writing custom parsers

Aperta
#208 0 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
cpp
Ambito
documentation

Direzione di ricerca

Inizia in doc/tutorial.qbk intorno alla riga 3792 e leggi la sezione sui parser personalizzati. Rivedi la formulazione per renderla più neutrale e aggiungi indicazioni o un esempio che affronti letterali complessi come 5 'D 3 di SystemVerilog. Il lavoro sarà completo quando la sezione spiegherà quando i parser personalizzati sono appropriati e fornirà agli utenti indicazioni pratiche.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

https://github.com/boostorg/parser/blob/f468d529fe440313d9d67d092f360b1a64a6f702/doc/tutorial.qbk#L3792

Thank you for your work on Boost Parser. It's an impressive library, and I've found it quite powerful.

While I appreciate the humor in the writing, I found the tone to be slightly dismissive of scenarios where writing custom parsers might genuinely be the most effective solution. For instance, I am working on parsing SystemVerilog code, which includes number literals with unique syntax, such as 5 'D 3. Parsing such constructs character by character using char_ primitives seems neither convenient nor effective, and it would make a strong case for writing a custom parser akin to uint_.

I believe this use case illustrates that there are situations where users might reasonably need more guidance on creating low-level parsers. If this section of the documentation could include:

  1. A more neutral tone when addressing the use of custom parsers.
  2. An example of how to effectively handle complex cases (like SystemVerilog number literals) using the library's primitives or via a custom parser.

This approach would make the documentation more inclusive and better serve a wider range of users.

Thank you again for your efforts, and I hope my feedback helps in further refining the excellent resources you provide.

Lingua principale
C++
Stelle
183
Fork
28
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di boostorg/parser

Tutte le issue di boostorg/parser

Issue simili

Altre issue su C++

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.