Code Monkey home page Code Monkey logo

Comments (6)

chinpei215 avatar chinpei215 commented on September 12, 2024

Can we have four tables?

  1. The property summary (similar to the method summary)
  2. The method summary (https://developers.google.com/apps-script/reference/spreadsheet/spreadsheet#methods)
  3. The property details (similar to the method details)
  4. The method details (https://developers.google.com/apps-script/reference/spreadsheet/spreadsheet#detailed-documentation)

from cakephp-api-docs.

markstory avatar markstory commented on September 12, 2024

Most properties don't have much in the way of details. Are you thinking that the property summary would be just one line of text?

from cakephp-api-docs.

chinpei215 avatar chinpei215 commented on September 12, 2024

Are you thinking that the property summary would be just one line of text?

Yes, I am.

We might have some additional information in the properties detail - Accesibility, Default value, Since, and See also, like a java reference.
https://docs.oracle.com/javase/8/javafx/api/javafx/scene/web/WebView.html#property.summary
But the properties detail might not be required, if we have a readable properties summary.

And I forgot about constants. The constants summary looks pretty readable to me.
http://api.cakephp.org/3.2/class-Cake.ORM.Table.html#constants

from cakephp-api-docs.

markstory avatar markstory commented on September 12, 2024

Our current property details includes default values. I'll draft up a properties summary this weekend and post screen shots.

from cakephp-api-docs.

chinpei215 avatar chinpei215 commented on September 12, 2024

OK. Thank you always.

from cakephp-api-docs.

markstory avatar markstory commented on September 12, 2024

Pull request up now.

from cakephp-api-docs.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.