Jira (PDOC-193) Evaluate using `yard i18n` to extract doc string content into POT files

[Jesse Scott (JIRA)]

Jesse Scott created an issue

Puppet Strings / PDOC-193 Evaluate using `yard i18n` to extract doc string content into POT files Issue Type: Improvement Assignee: Unassigned Created: 2017/12/13 6:03 AM Priority: Normal Reporter: Jesse Scott Since 0.8.0 yard has included an i18n subcommand to place all the doc strings into a .pot file. It seems like if we just run this automatically when a user invokes puppet strings that would go a long way to enabling i18n workflows for module documentation. Add Comment

This message was sent by Atlassian JIRA (v7.0.2#70111-sha1:88534db)

[Eric Putnam (JIRA)]

Eric Putnam assigned an issue to Eric Putnam

Puppet Strings / PDOC-193 Evaluate using `yard i18n` to extract doc string content into POT files

Change By: Eric Putnam Assignee: Eric Putnam

Add Comment

[Eric Putnam (JIRA)]

Eric Putnam updated an issue

Puppet Strings / PDOC-193

Evaluate using `yard i18n` to extract doc string content into POT files

Change By: Eric Putnam Issue Type: Improvement Task

Add Comment

This message was sent by Atlassian JIRA (v7.5.1#75006-sha1:7df2574)

[Eric Putnam (JIRA)]

Eric Putnam updated an issue

Puppet Strings / PDOC-193 Evaluate using `yard i18n` to extract doc string content into POT files

Change By: Eric Putnam Story Points: 1

Add Comment

[Eric Putnam (JIRA)]

Eric Putnam updated an issue

Puppet Strings / PDOC-193 Evaluate using `yard i18n` to extract doc string content into POT files Change By: Eric Putnam

Since 0.8.0 yard has included an {{i18n}} subcommand to place all the doc strings into a .pot file. It seems like if we just run this automatically when a user invokes {{puppet strings}} that would go a long way to enabling i18n workflows for module documentation.

You can see this in raw action by simply calling the CLI tool from the PuppetStrings.generate method and then running strings on a module. {code} YARD::CLI::I18n.run(search_patterns) {code}

Add Comment

This message was sent by Atlassian JIRA (v7.7.1#77002-sha1:e75ca93)

[Eric Putnam (JIRA)]

Eric Putnam updated an issue

Puppet Strings / PDOC-193 Evaluate using `yard i18n` to extract doc string content into POT files Change By: Eric Putnam

Since 0.8.0 yard has included an {{i18n}} subcommand to place all the doc strings into a .pot file. It seems like if we just run this automatically when a user invokes {{puppet strings}} that would go a long way to enabling i18n workflows for module documentation. You can see this in raw action by simply calling the CLI tool from the PuppetStrings.generate method and then running strings on a module.

{code :ruby } YARD::CLI::I18n.run(search_patterns) {code}

Add Comment

[Eric Putnam (JIRA)]

Eric Putnam updated an issue

Puppet Strings / PDOC-193 Evaluate using `yard i18n` to extract doc string content into POT files

Change By: Eric Putnam Attachment: yard.pot

Add Comment

[Eric Putnam (JIRA)]

Eric Putnam updated an issue

Puppet Strings / PDOC-193 Evaluate using `yard i18n` to extract doc string content into POT files Change By: Eric Putnam

Since 0.8.0 yard has included an {{i18n}} subcommand to place all the doc strings into a .pot file. It seems like if we just run this automatically when a user invokes {{puppet strings}} that would go a long way to enabling i18n workflows for module documentation. You can see this in raw action by simply calling the CLI tool from the PuppetStrings.generate method and then running strings on a module. {code:ruby} YARD::CLI::I18n.run(search_patterns) {code}

You can see from the attached file, there's a lot of stuff that we won't want in there. It will be confusing to the translator and lots of unnecessary work. A few examples: A lot of tags get the tag itself extracted into a msgid that looks like the one here: {code} # @param [String] #: ../lib/puppet/type/radius.rb:3 #: ../manifests/install.pp:10 msgid "tag|param|name" msgstr "" {code} First of all, we don't want the param name translated. Second, that's just confusing to look at. In other cases, we _do_ want part of this msgid. This mostly occurs in examples: {code} # @example #: ../lib/puppet/type/radius.rb:3 msgid "tag|example|Here's an example" msgstr "" {code} Finally, we don't want to translate code examples, obviously {code} # @example Using the type. #: ../lib/puppet/type/test.rb:3 msgid "test { 'mctesterson':\n" "  foo     => 'hi',\n" "  my_prop => 'bar',\n" "}" msgstr "" {code}

Add Comment

[Eric Putnam (JIRA)]

[Eric Putnam (JIRA)]

Eric Putnam assigned an issue to Unassigned

Puppet Strings / PDOC-193 Evaluate using `yard i18n` to extract doc string content into POT files

Change By: Eric Putnam Assignee: Eric Putnam

Add Comment