pcb

The N_ macro is spoiling the user documentation

Bug #1505262 reported by Bert Timmerman
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
pcb
Fix Released
High
Bert Timmerman

Bug Description

Generating user documentation with "--enable-doc" gives unwanted "N_" text in a lot of places in pcb.pdf.

G.1.72 SetLayertype
                                                                                         ̈
  N_("SetLayertype(layer, type)");
                                                                                       ©
   N_("Sets the type of a layer. Type can be given by name or by number. For a list of
available types, run ListLayertypes().");
   Layers can have various types, like copper, silk or outline. Behaviour of GUI and ex-
porters largely depend on these types. For example, searching for electrical connections
searches only layers of type copper, all other layers are ignored.
   For a list of available types see see Section G.1.41 [ListLayertypes Action], page 125.

G.1.73 SetOctagon
                                                                                      ̈
  N_("SetOctagon(Object|ToggleObject|SelectedElements|Selected)");

Tags: docs
Revision history for this message
Vladimir Zhbanov (vzhbanov) wrote :

One of the ways to solve this is to remove N_'s and make comments for future developers to not add those strings to translation.

Revision history for this message
Bert Timmerman (bert-timmerman) wrote :

Starting at:

Appendix G Action Reference

G.1 Core actions

G.1.1 AddRats

N ("AddRats(AllRats|SelectedRats|Close)");

Revision history for this message
Bert Timmerman (bert-timmerman) wrote :

Another more cumbersome way is to move *all* user documentation related stuff into pcb.texi.

Revision history for this message
Vladimir Zhbanov (vzhbanov) wrote : Re: [Bug 1505262] Re: The N_ macro is spoiling the user documentation

On Mon, Oct 12, 2015 at 05:15:22PM -0000, Bert Timmerman wrote:
> Another more cumbersome way is to move *all* user documentation related
> stuff into pcb.texi.

AFAICR, inline documentation was introduced in order to keep the docs
up-to-date.

Revision history for this message
DJ Delorie (djdelorie) wrote :

Right, at the moment the inline documentation is the only documentation that's actually up to date.

Revision history for this message
Bert Timmerman (bert-timmerman) wrote :

OK, shall I start removing the culprits ?

Revision history for this message
Bert Timmerman (bert-timmerman) wrote :

Fix committed to master.

Changed in pcb:
status: New → Fix Committed
importance: Undecided → High
assignee: nobody → Bert Timmerman (bert-timmerman)
milestone: none → next-bug-release
Changed in pcb:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.