doc_file: Package-wide description of 'file' parameter

View source: R/doc.R

doc_fileR Documentation

Package-wide description of file parameter

Description

A dummy function to be referred by ⁠@inheritParams⁠ for a parameter documentation.

Usage

doc_file(file)

Arguments

file

Path to a file relative to project folder root. Can contain only letters, digits, '-', '_', '.', spaces and '/' symbols.


cloudfs documentation built on May 29, 2024, 11:08 a.m.