[bug #58711] correcting errors in documentation inquiry

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

[bug #58711] correcting errors in documentation inquiry

Kevin Cuzner-2
URL:
  <https://savannah.nongnu.org/bugs/?58711>

                 Summary: correcting errors in documentation inquiry
                 Project: AVR C Runtime Library
            Submitted by: lemonforest
            Submitted on: Sun 05 Jul 2020 09:41:26 PM UTC
                Category: Documentation
                Severity: 3 - Normal
                Priority: 5 - Normal
              Item Group: Documentation
                  Status: None
             Assigned to: None
        Percent Complete: 0%
        Originator Email:
             Open/Closed: Open
         Discussion Lock: Any
                 Release: 2.0.0
           Fixed Release: None

    _______________________________________________________

Details:

* as it relates to .dox files

In the doxy source for the manual, how should spelling/grammar related
corrections be handled? The rate at which I come across areas in the
documentation in need of corrections is rather low.  I also manage to forget
about them shortly afterwards and don't presently write them down (but could
use highlighting in the PDF I just realized). I did check if the online manual
had the same error as well, thus this submission.

I realize it's tremendously less critical than the actual avr library so is
this something even worth tracking externally or is it something that the crew
is likely to find eventually and correct. I am cloning the SVN since even
attaching the file to diff would take a lot less time than describing where
attention would be needed.

Thanks!




    _______________________________________________________

Reply to this item at:

  <https://savannah.nongnu.org/bugs/?58711>

_______________________________________________
  Message sent via Savannah
  https://savannah.nongnu.org/


Reply | Threaded
Open this post in threaded view
|

[bug #58711] correcting errors in documentation inquiry

Kevin Cuzner-2
Follow-up Comment #1, bug #58711 (project avr-libc):

It is completely fine to issue tickets for such errors.

    _______________________________________________________

Reply to this item at:

  <https://savannah.nongnu.org/bugs/?58711>

_______________________________________________
  Message sent via Savannah
  https://savannah.nongnu.org/


Reply | Threaded
Open this post in threaded view
|

[bug #58711] correcting errors in documentation inquiry

Kevin Cuzner-2
Follow-up Comment #2, bug #58711 (project avr-libc):

Ok, thanks. I'll make corrections as I find them then, as I get time, rebase
and go back through the entire chapter before opening a ticket unless it'd be
better to just keep it all in here.

Thanks!

    _______________________________________________________

Reply to this item at:

  <https://savannah.nongnu.org/bugs/?58711>

_______________________________________________
  Message sent via Savannah
  https://savannah.nongnu.org/