You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Note that this does not throw errors if your file is not present. Hence, when using this feature make sure that the contents are being rendered as expected.
Why is that so? Is there any reasoning behind this decision?
IMO, throwing an error is totally essential for this feature to be usable. The suggestion to "make sure that it is rendered fine" is not suitable for any long-running documentation project - people do make mistakes anyway. Having an automated tool that will not allow you to make mistake is a way to build a robust software. Moreover, this feature seems to be trivial to implement.
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
Uh oh!
There was an error while loading. Please reload this page.
-
"Markdown inclusion" section contains the warning:
Why is that so? Is there any reasoning behind this decision?
IMO, throwing an error is totally essential for this feature to be usable. The suggestion to "make sure that it is rendered fine" is not suitable for any long-running documentation project - people do make mistakes anyway. Having an automated tool that will not allow you to make mistake is a way to build a robust software. Moreover, this feature seems to be trivial to implement.
Beta Was this translation helpful? Give feedback.
All reactions