Skip to content
#

Documentation

Documentation is a set of information that describes a product to its users, including what it is, how it operates, and how to use it.

Here are 5,257 public repositories matching this topic...

storybook
afebbraro
afebbraro commented Oct 28, 2019

Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

  1. Go to 'https://storybookjs.now.sh/official-storybook/?path=/story/addons-jest--with-tests'
    in a narrow width browser.
  2. Click on the Tests panel.
  3. Scroll down to see the tests panel.
  4. See the total number of tests and total time covering up the "Todo" tex
tldr
dbrgn
dbrgn commented Feb 28, 2020

The spec says:

If a client has access to environment variables, several standard ones exist to specify the language in which a client should operate. If not, then clients MUST make reasonable assumptions based on the information provided by the environment in which they operate (e.g. consulting navigator.languages in a browser, etc.).

Windows systems do have environment variables, but the

docz
50l3r
50l3r commented Sep 3, 2019

I cant view data, properties or something in vue devtools. Only blank page

Open devtools, select vue tab and navigate into components:

  • Node version: 10.16.0
  • NPM version: 6.9.0
  • vue-cli version: (if necessary)
  • Operating System: Windows 10 X64
MichielDG
MichielDG commented Mar 13, 2020

Version

v1.4.10

Development Environment

Chrome 80.0.3987.132

Current Behavior

Write a description of the current operation. You can add sample code, 'CodePen' or 'jsfiddle' links.

// Write example code
Go to section
* [Hello](#hello)  
* [Hello World](#hello-world)
* [Another section](#new-section)    <-- it's called 'Another section' in this list but refers to 'New
OmgImAlexis
OmgImAlexis commented Dec 19, 2019

Input code

/**
 * Canvas
 *
 * @class Canvas
 */
class Canvas {
    /**
     * Creates an instance of Canvas.
     * @returns {HTMLCanvasElement}
     * @memberof Canvas
     */
    constructor(width, height) {
        const canvas = document.createElement('canvas');
        canvas.width = width;
   
react-styleguidist
wiki
DelfrCorp
DelfrCorp commented Oct 9, 2019

I am relatively new to GitHub and even newer to Wiki.js & struggled for several hours to properly configure port 80 and 443 proxying to get the wiki my colleague built for our company to automatically work with port 80 & 443 and automatically redirect to port 443 and have it work properly with the wiki node proxy.

I would like to suggest a quick addition of a full proper nginx config (example b

jdelman
jdelman commented Jul 17, 2019

When rotating between landscape/portrait, you can lose your open document and position. I have encountered this issue on an iPhone XS Max running iOS 12.3.1.

Steps to recreate:

  • Search for something.
  • View an article.
  • Rotate into landscape mode (on my iPhone XS Max, this shows the search view and the document view side-by-side)
  • Rotate back to portrait

Expected behavior: Show

DigitalBrainJS
DigitalBrainJS commented Feb 24, 2020

Is there any particular way to document overloaded constructor?
For example, I would like to document the following constructor:

class Pokemon{
    /**
     * @param {Object} options - some options
     *//**
     * @param {String} name - pokemon's name
     */
    constructor(arg0){
        const options = typeof arg0 === 'object' ? arg0 : {name: arg0};
        //do something with 
estaub
estaub commented Mar 6, 2020

The typeof operator, as used in type queries rather than Javascript, isn't documented, other than as used in documentation of other things, like type guards. Because it is overloaded from the Javascript operator, there can be lots of novice puzzlement.

If your reaction is "that can't possibly be", please look for yourself!

I'd provide a PR, but the wording should be much more precise and co

mootari
mootari commented Dec 28, 2017

Assemble's highly modular nature makes it difficult to discover methods that are added via mixins or inheritance. For example, .use and .define are provided by Base and implicitely added through Templates.

It would be a huge help to have some basic, generated JSDocs that incorporate all of the default packages. JSDoc provides the @mixinand [`@mix

Wikipedia
Wikipedia
You can’t perform that action at this time.