Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Repo info
Activity
    Grégory Copin
    @Gregcop1
    pour voir à quoi ça ressemble chez un développeur qui adore écrire de la doc ;), ça donne ça : http://coffeedoc.info/github/Plou/lunr-gmap/f9c0353b45b6d025d13eadd3f9023eadf52cddb5/
    Plou
    @Plou
    Mais effectivement c’est pas mal pour de la doc
    mouais il faut pas la lire dans les détails non plus :D
    Grégory Copin
    @Gregcop1
    héhé, j'ai vu ça :p
    il me fait chier le smiley : package:
    Grégory Copin
    @Gregcop1
    pour les plus chauds d'entre vous, le truc dont il faudrait s'inspirer c'est ça :
    https://github.com/Warin/Sublime/blob/master/DocBlockr/jsdocs.py
    Plou
    @Plou
    toofff
    @toofff
    C'est beau :clap:
    Grégory Copin
    @Gregcop1
    pourquoi [Mobile] et pas Mobile dans le return ?
    Grégory Copin
    @Gregcop1
    ok, c'est la façon normale dont on écrit les return en fait
    Plou
    @Plou
    :p
    c’est le type de la valeur retournée
    dans ce cas c’est une instance de Mobile
    Grégory Copin
    @Gregcop1
    Oui oui, c'est juste que j'étais surpris des crochets mais ça fait parti de la syntaxe
    Grégory Copin
    @Gregcop1
    un petit gist cadeau pour enchaîner les déclarations de paramètres en coffeescript
    Plou
    @Plou
    Il faudra penser à changer la description et à virer le readme
    Grégory Copin
    @Gregcop1
    Oops, j'ai mis à jour le gist avec + de possibilité
    vous pouvez donc :
    #+tab -> ajouter un @param à la doc
    #<+tab -> ajouter un @return à la doc
    #o+tab -> ajouter une @option à la doc
    #e+tab -> ajouter un @event à la doc
    toofff
    @toofff
    :+1:
    Plou
    @Plou
    +1
    Le coffeescrpt peut être vite obscure:
    $.getHash = (url) ->
      url?.substring(url.indexOf('#') + 1) || window.location.hash
    return (url != null ? url.substring(url.indexOf('#') + 1) : void 0) || window.location.hash;
    (if url then url.substring(url.indexOf('#') + 1) else window.location.hash)
    toofff
    @toofff
    $.getHash = (url) ->
      url = if url then url.substring(url.indexOf('#') + 1) else window.location.hash;
    toofff
    @toofff
    J'ai commencé hier soir la partie php pour le guide de style. Je vais le finir dans les jours qui arrivent. On pourras en parler des que j'aurais finit.
    https://github.com/Inouit/styleguide/blob/php/php%2FREADME.md
    Grégory Copin
    @Gregcop1
    par là, tu veux dire maxium mercredi prochain, c'est ça ? ;)
    toofff
    @toofff
    C'est ça :smile:
    Plou
    @Plou
    Le PSR n’est pas fait pour ça ?
    toofff
    @toofff
    Si justement, mais je ne reprends pas tout. C'est plus un PSR light que je vais vous proposer.
    Grégory Copin
    @Gregcop1
    je crois qu'un exemple de classes serait beaucoup plus agréable à lire que ce pavé de règles ;)
    toofff
    @toofff
    je vais faire les deux justement, le pavé simplifier et un exemple de classe
    Grégory Copin
    @Gregcop1
    à quoi sert le pavé si il y a la classe
    toofff
    @toofff
    sachant que dans le PSR il manque la documentation, ce que je dois ajouter
    Grégory Copin
    @Gregcop1
    autant faire juste la classe et garder 3 ou 4 lignes d'explication pour ce qui n'est pas visible (espacement, encodage, ...)
    toofff
    @toofff
    c'est ce que j'étais entrain d'écrire :worried:
    Grégory Copin
    @Gregcop1
    Une petite erreur s'était glissée dans le snippet pour @param donc le gist a changé et son url aussi
    toofff
    @toofff
    je en vois pas ce qui change!
    Grégory Copin
    @Gregcop1
    héhé :)
    Grégory Copin
    @Gregcop1
    Hey @/all quelqu'un a préparé une class coffeescript documentée pour la réu ?
    toofff
    @toofff
    Pas du tout, ce midi je finis la partie PHP
    Plou
    @Plou
    Sans événements
    Grégory Copin
    @Gregcop1
    # Insert the element in the dom with the given jQuery method refering to the target
      # @private
      #
      # TODO Call the given method with error handling, remove switch case
      #
      # @return [Mobile]
      #
      _insert: ($el, target, method)
    T'as pas l'impression qu'il manque quelques params ? fenec :)
    Plou
    @Plou
    Il manque quelques trucs effectivement
    Grégory Copin
    @Gregcop1
    ça conviendrait comme modèle ?
    $ = require 'jquery'
    
    # Create a Car
    # 
    # @example How to init the car
    #   car = new Car( '#garage', 4 )
    #
    
    ###*
     * Create a Car
     * @example How to park the car
     *   car = new Car( '#garage', 'A4' )
     * @example How to park the car on the first free place
     *   car = new Car( '#garage' )
    ###
    modules.exports = class Car
    
      ###*
       * Construct the car
       * @property  {Object} @container where the Car will be parked
       * @property  {String} placeNumber 
       * @param {Bool} isThereADeadBodyInTheTruck
       * @event Car.parked is triggered when the car is parked into a garage
       * @return {Car}
      ###
      constructor: (@container, @placeNumber, isThereADeadBodyInTheTruck)->
        @placeNumber ?= @getFirstFreePlace()
    
        @initialize()
          .binds()
    
        @el.trigger('Car.created')
      return @
    
      # ...
    
      ###*
       * Manage listerners
       * @event Garage.frontDoorOpened Listen for front door opening
       * @return {Car} 
      ###
      binds: ->
        $('body').on('Garage.frontDoorOpened', @doStuff)
        return @Plou
    Je vais checker si ça passe avec Codo et le linter
    Plou
    @Plou
    En commençant à réfléchir sur les divers documents et guide de contribution à établir et rédiger, je suis tombé là dessus, c’est proche de ce que l’on fait mais un peu plus carré