Comments (13)
@appgurueu please you assign this issue to me
from javascript.
Documentation of constructor parameters of course needs to go with the constructor. Feel free to fix this. But a general description of the class should stick with the class and not be moved to the constructor.
from javascript.
But when we keep the description to the constructor
, it appears for the main class as well. That's how classes work with jsdoc. So you mean I need to go through all the files and fix it 😅. It's not that I don't want to do it but it's gonna take a lot of grind.
from javascript.
But when we keep the description to the constructor, it appears for the main class as well
I'm not sure what you mean by this. In the documentation you linked, the example is
/** Class representing a point. */
class Point {
/**
* Create a point.
* @param {number} x - The x value.
* @param {number} y - The y value.
*/
constructor(x, y) { ... }
...
}
So clearly the description - in this case "Class representing a point" - should stick with the class rather than being moved to the constructor.
So you mean I need to go through all the files and fix it
You don't need to fix it, but you may fix it. You could consider automatizing this with some RegEx; use whatever you are most comfortable with.
It's not that I don't want to do it but it's gonna take a lot of grind.
It's fine, you don't have to fix it by any means. There are more interesting problems to solve than to fix this :)
from javascript.
I'm sorry, I messed up a little. I came here as soon as I realized I messed up and saw your reply. I'm currently working on adding more shapes to the Geometry folder (like the square, rectangle, triangle, cube, etc.)
from javascript.
Also, are there proper guidelines to write the code in? For example, use this and that for jsdoc, or use x spaces or x tabsize for indentation, etc.
from javascript.
Also, are there proper guidelines to write the code in? For example, use this and that for jsdoc, or use x spaces or x tabsize for indentation, etc.
See our contribution guidelines. We use StandardJS style, so 2 spaces for indentation. As for JSDoc: Just refer to their docs for best practice.
from javascript.
I just realized, nowhere in the CONTRIBUTING.md
does it say that I don't have to use the ;
to end the sentence, so am I allowed to use it? I've seen all files do not use them, I might have missed checking a few.
from javascript.
I just realized, nowhere in the
CONTRIBUTING.md
does it say that I don't have to use the;
to end the sentence, so am I allowed to use it? I've seen all files do not use them, I might have missed checking a few.
I'm not sure what you mean by this. If you mean using semicolons to delimit statements rather than relying on automatic semicolon insertion, please avoid this to comply with StandardJS style. Of course you have to keep using them in for
-loops or the like though.
If you're referring to usage of ;
as english punctuation: That is allowed within comments. If you do use it, note that it does not end, but rather separate sentences; it is effectively a compromise between a comma (,
) and a colon (:
). See e.g. Collins Dictionary for how to use semicolons in English.
from javascript.
By sentence, i meant a code line. Thanks for clarifying
from javascript.
@appgurueu
Please assign this issue to me.
from javascript.
@appgurueu is this issue still open I want to contribute on cleaning up doc string?
from javascript.
@mohmmadAyesh sure, feel free to work on it. (Please don't add redundant comments, though.)
from javascript.
Related Issues (20)
- Fet: add "M-Coloring" Problem in Backtracking HOT 1
- Fet: Octal To Binary Convertor HOT 1
- Fet: Added "Octal To Binary" in Coversion Section HOT 1
- [OTHER]: It is not looks good for create a separate section for connect with us section. HOT 1
- [FEATURE]: Last Element HOT 6
- [FEATURE]: Height of tree HOT 3
- [FEATURE]: Switch to Bun or Vitest for running tests HOT 6
- [Question]: How can i work on multiple file? do i have to wait for first pr to be merged? HOT 1
- [FEATURE]: Length Conversion HOT 1
- [FEATURE]: HOT 2
- [FEATURE]: Add a palindrome validating code in the "string" folder under Hacktoberfest HOT 3
- [OTHER]: Grammar Mistake HOT 1
- [OTHER]: Add gidpod ready to code badge in README.md HOT 1
- [FEATURE]: DISJOINT SET
- Backtracking HOT 1
- [FEATURE]: Data structure, Disjoint Set HOT 1
- [FEATURE]: Hash Table Data Structure HOT 1
- [FEATURE]: Adding A workflow insuring including JSDOCS on every PR HOT 3
- [OTHER]: Duplicate entry of sieve of eratosthenes HOT 7
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from javascript.