# \`write file\` node - documentation question

**URL:** https://discourse.nodered.org/t/write-file-node-documentation-question/70373
**Category:** General
**Created:** [10 November 2022 04:31 UTC](https://discourse.nodered.org/t/write-file-node-documentation-question/70373 "2022-11-10T04:31:29Z")
**Posts on this page:** 10
**Page:** 1

<div class="post-metadata">

### Author: ![Trying\_to\_learn](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/trying_to_learn/32/28400_2.png) [@Trying\_to\_learn](https://discourse.nodered.org/u/Trying_to_learn)
#### Post date: [10 November 2022 04:31 UTC](https://discourse.nodered.org/t/write-file-node-documentation-question/70373/1 "2022-11-10T04:31:29Z")

</div>

NR 3.0.2

I was reading someone's question about file writing.

Opening the `write file` node, I'm confused.

 ![Screenshot from 2022-11-10 15-29-34](https://us1.discourse-cdn.com/flex026/uploads/nodered/original/3X/2/3/23e02f6f3ad92d2fb600a1f38e341e9a63a4ce13.png)

Where is `path` explained in the documentation as `input`?

---

<div class="post-metadata">

### Author: ![Steve-Mcl](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/steve-mcl/32/4826_2.png) [@Steve-Mcl](https://discourse.nodered.org/u/Steve-Mcl)
#### Post date: [10 November 2022 06:54 UTC](https://discourse.nodered.org/t/write-file-node-documentation-question/70373/2 "2022-11-10T06:54:20Z")

</div>

There is an open issue to update the help for the file node. Maybe you would be willing to fix it with a PR?

---

<div class="post-metadata">

### Author: ![Trying\_to\_learn](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/trying_to_learn/32/28400_2.png) [@Trying\_to\_learn](https://discourse.nodered.org/u/Trying_to_learn)
#### Post date: [10 November 2022 09:09 UTC](https://discourse.nodered.org/t/write-file-node-documentation-question/70373/3 "2022-11-10T09:09:06Z")

</div>

(Showing how dumb I am)

What is a `PR`?

---

<div class="post-metadata">

### Author: ![TotallyInformation](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/totallyinformation/32/31_2.png) [@TotallyInformation](https://discourse.nodered.org/u/TotallyInformation)
#### Post date: [10 November 2022 11:56 UTC](https://discourse.nodered.org/t/write-file-node-documentation-question/70373/4 "2022-11-10T11:56:16Z")

</div>

A "Pull Request". Basically, you clone the GitHub repository, make a change and then submit a PR to ask the devs to review your changes and merge them back in if they approve.

---

<div class="post-metadata">

### Author: ![Trying\_to\_learn](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/trying_to_learn/32/28400_2.png) [@Trying\_to\_learn](https://discourse.nodered.org/u/Trying_to_learn)
#### Post date: [10 November 2022 20:04 UTC](https://discourse.nodered.org/t/write-file-node-documentation-question/70373/5 "2022-11-10T20:04:18Z")

</div>

Thanks, but I don't see how me doing that would _work_.

I was looking at a node and saw a disparity between what the node offers as options and what is shown in the documents. There is nothing shown.

As I don't understand what the option is supposed to do, I can't see how I can add any useful information to it.

I am mentioning that I see this disparity and would like to confirm there actually is a problem with the documents as supplied.

# What is the `path` option and how to use it.

---

<div class="post-metadata">

### Author: ![Steve-Mcl](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/steve-mcl/32/4826_2.png) [@Steve-Mcl](https://discourse.nodered.org/u/Steve-Mcl)
#### Post date: [10 November 2022 20:20 UTC](https://discourse.nodered.org/t/write-file-node-documentation-question/70373/6 "2022-11-10T20:20:26Z")

</div>

> [@Trying\_to\_learn](#):
>
> What is the `path` option and how to use it.

That is not what you asked.

You asked...

> [@Trying\_to\_learn](#):
>
> Where is `path` explained in the documentation as `input`?

To which I said...

> [@Steve-Mcl](#):
>
> There is an open issue to update the help for the file node. Maybe you would be willing to fix it with a PR

* * *

Given the option is named "path" and we are discussing the "file" nodes, I think you can safely assume `path` means "the path to a file" (while `msg.` and `flow.` mean "variables that contain the path to a file`)

But yes, it should be clarified in the help.

---

<div class="post-metadata">

### Author: ![Trying\_to\_learn](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/trying_to_learn/32/28400_2.png) [@Trying\_to\_learn](https://discourse.nodered.org/u/Trying_to_learn)
#### Post date: [10 November 2022 20:25 UTC](https://discourse.nodered.org/t/write-file-node-documentation-question/70373/7 "2022-11-10T20:25:20Z")

</div>

@Steve-Mcl  
Steve,

I am sorry.

I misread that as NOT an open issue.

Dyslexia is getting worse.

However, I don't see how I can _fix_ it if I don't know what it is supposed to mean/do.

---

<div class="post-metadata">

### Author: ![Steve-Mcl](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/steve-mcl/32/4826_2.png) [@Steve-Mcl](https://discourse.nodered.org/u/Steve-Mcl)
#### Post date: [10 November 2022 20:27 UTC](https://discourse.nodered.org/t/write-file-node-documentation-question/70373/8 "2022-11-10T20:27:47Z")

</div>

> [@Trying\_to\_learn](#):
>
> However, I don't see how I can _fix_ it if I don't know what it is supposed to mean/do

No bother, it will get sorted.  
If you did know what path meant (as I assumed you might do from your first post) a PR would have been nice (community spirit 'n' all).

---

<div class="post-metadata">

### Author: ![Trying\_to\_learn](https://sea2.discourse-cdn.com/flex026/user_avatar/discourse.nodered.org/trying_to_learn/32/28400_2.png) [@Trying\_to\_learn](https://discourse.nodered.org/u/Trying_to_learn)
#### Post date: [10 November 2022 20:29 UTC](https://discourse.nodered.org/t/write-file-node-documentation-question/70373/9 "2022-11-10T20:29:31Z")

</div>

OH, I do agree.

I just got stuck with it - me asking the question - while helping someone else who was using the node, posted their code and I was looking at it.

Anyway, all good - kinda. 😉

I do hope it gets resolved easily.

---

<div class="post-metadata">

### Author: ![system](https://us1.discourse-cdn.com/flex026/uploads/nodered/original/1X/d073cd938eafa2e558d7c2cd59003b3ef4963033.png) [@system](https://discourse.nodered.org/u/system)
#### Post date: [9 January 2023 20:30 UTC](https://discourse.nodered.org/t/write-file-node-documentation-question/70373/10 "2023-01-09T20:30:27Z")

</div>

This topic was automatically closed 60 days after the last reply. New replies are no longer allowed.
