当创建包时,会生成pdf文档手册。如果从手册中的示例中复制代码,则可以预期代码将运行。但是,当开发人员使用单引号时,会将其转换为特殊字符(单引号)。双引号不是这样。一般来说,我使用“使用双引号”的哲学,但有时你需要一个引号,例如在正则表达式中。
如何强制构建包帮助文档以使用单引号,以便用户可以剪切并粘贴到控制台?
MWE - 这是一个软件包仓库,我在函数kill_bot
中演示了这一点:https://github.com/trinker/SOdemoing
在@examples
中,我在pdf手册中包含一个直接的单引号转换为卷曲引号:https://dl.dropboxusercontent.com/u/61803503/SOdemoing.pdf
然后我从pdf手册复制到R控制台并获得以下内容:
library(SOdemoing)
iconv(kill_bot("’"), "", "ASCII", "byte")
## > iconv(kill_bot("’"), "", "ASCII", "byte")
## ’
## [1] "<92>"
但是我剪切和粘贴时想要看到的是:
iconv(kill_bot("'"), "", "ASCII", "byte")
## > iconv(kill_bot("'"), "", "ASCII", "byte")
## '
## [1] "'"