coreapi unixfs: fix inline doc
License: MIT Signed-off-by: Łukasz Magiera <magik6k@gmail.com> This commit was moved from ipfs/interface-go-ipfs-core@641542e1596817f70eeac14f87b3c49ef2d5e80a This commit was moved from ipfs/boxo@f46082072957d0f4634a70baec4f0ef573c89408
Łukasz Magiera committed
Oct 4, 2018 at 20:39 UTC
e59b75ae4394525d2902dfb8bffc89214ef5e759
1 file changed
+4
-7
core/coreiface/options/unixfs.go
+4
-7
@@ -170,13 +170,10 @@ func (unixfsOpts) Inline(enable bool) UnixfsAddOption {
170
// Specifying this option won't enable block inlining. For that use `Inline`
171
// option. Default: 32 bytes
172
//
173
-// Note that while there is no hard limit on the number of bytes, it should
174
-// be kept at a reasonably low value, like 64 bytes if you intend to display
175
-// these hashes. Larger values like 256 bytes will work fine, but may affect
176
-// de-duplication of smaller blocks.
177
-//
178
-// Setting this value too high may cause various problems, such as render some
179
-// blocks unfetchable
173
+// Note that while there is no hard limit on the number of bytes, it should be
174
+// kept at a reasonably low value, such as 64 and no more than 1k. Setting this
175
+// value too high may cause various problems, such as render some
176
+// blocks unfetchable.
177
func (unixfsOpts) InlineLimit(limit int) UnixfsAddOption {
178
return func(settings *UnixfsAddSettings) error {
179
settings.InlineLimit = limit