Elixir 1.3.0：缺少String.strip / 1和String.strip / 2 API文档。 [英] Elixir 1.3.0: String.strip/1 and String.strip/2 API documentation missing.

问题描述

Elixir 1.3.0似乎不再显示String.strip / 1和String.strip / 2的文档：

It seems that Elixir 1.3.0 doesn't show anymore the documentation for String.strip/1 and String.strip/2:

iex(1)> h String.strip
No documentation for String.strip was found

它们也丢失了当前的在线文档（v1.3，Master，Stable），但编译器仍可以识别这些功能：

they are missing also in the current online documentation (v1.3, Master, Stable), but the functions are still recognized by the compiler:

iex(2)> String.strip("   Hallo, World!   ")
"Hallo, World!"

所以我想知道这是否只是String文档中的错误，或者这些功能是否正在使用被弃用。我找不到任何更好的信息。

So I'm wondering if this is just a bug in String documentation, or if these functions are going to become deprecated. I can't find any better information googling.

推荐答案

这些功能已被软弃用。这意味着它们已被标记为 @doc false 。目前，该计划是以1.5的警告值弃用

These functions have been soft deprecated. This means they have been marked as @doc false. Currently the plan is to deprecate with warnings by 1.5.

https://github.com/elixir-lang/elixir/blob/v1.3/CHANGELOG.md#3-soft-deprecations-no-warnings-emitted

[String]不赞成使用String的令人困惑的String.strip / 2，String.lstrip / 2和String.rstrip / 2 API已被弃用.trim / 2，String.trim_leading / 2和String.trim_trailing / 2

[String] The confusing String.strip/2, String.lstrip/2 and String.rstrip/2 API has been soft deprecated in favor of String.trim/2, String.trim_leading/2 and String.trim_trailing/2

这篇关于Elixir 1.3.0：缺少String.strip / 1和String.strip / 2 API文档。的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！