Comments (16)
They already are, it's just that there are some special ones at the top and the bottom. Adding some extra separators or subheadings would clarify that.
from faker.
Just for clarification:
You are suggesting that we should only display modules in the API sidebar? Or are the faker constructors lower on your screenshot?
As an alternative, we could group the sidebar into core (faker constructors, util) and modules.
from faker.
I'll give it a try。
from faker.
Thank you for your feature proposal.
We marked it as "waiting for user interest" for now to gather some feedback from our community:
- If you would like to see this feature be implemented, please react to the description with an up-vote (:+1:).
- If you have a suggestion or want to point out some special cases that need to be considered, please leave a comment, so we are aware about them.
We would also like to hear about other community members' use cases for the feature to give us a better understanding of their potential implicit or explicit requirements.
We will start the implementation based on:
- the number of votes (:+1:) and comments
- the relevance for the ecosystem
- availability of alternatives and workarounds
- and the complexity of the requested feature
We do this because:
- There are plenty of languages/countries out there and we would like to ensure that every method can cover all or almost all of them.
- Every feature we add to faker has "costs" associated to it:
- initial costs: design, implementation, reviews, documentation
- running costs: awareness of the feature itself, more complex module structure, increased bundle size, more work during refactors
View more issues which are waiting for user interest
from faker.
Adding a extra separator before Airline would make it clearer that the rest are in alphabetical order
from faker.
Yes, the APIs in sidebar can be sorted alphabetically。🤔
from faker.
@LARVAIDE Are you interested in creating a PR to implement this?
from faker.
From the code, it can be seen that 'Faker', 'SimpleFaker', and 'Randomizer' have special rules, among which 'Randomizer' is not quite the same. Why is this necessary? @ST-DDT
from faker.
Because those are classes whereas the others are "Modules".
Faker has some internal classes, methods and other stuff, that should not be exposed in the api docs. Such as:
- *BaseModules (because those would be redundant)
- Helper functions and classes used inside the faker functions
- Locale definition interfaces and data
- MersenneTwister implementation
For that reason we select which data we wish to expose:
- API Classes/Interfaces: 'Faker', 'SimpleFaker', and 'Randomizer' (somewhat hardcoded)
- API Modules: Any class that fullfills faker[some] = SomeModule`
- API Utilities (standalone functions): 'mergeLocales' (somewhat hardcoded)
from faker.
from faker.
That makes it look like Faker Core has its own page. But I don't think we have a link for that. Maybe Faker could be the "top level" item with others nested inside it?
from faker.
Or maybe use the following structure?
- API
- Faker
- SimpleFaker
- ...
- Modules
- Airline
- Animal
- ...
from faker.
I feel like the Modules are the most important part for most users so they should not be nested too deep. It's only for advanced usage you really need to delve too much into the constructors, Randomizer etc.
Maybe just a <hr>
to seperate the top section off without necessarily needing nesting or extra subheaders?
API
- Overview
- Faker
- SimpleFaker
- Randomizer
- Utilities
- Airline
- Animal
from faker.
Alternatively stick with this proposal but add a new markdown page "Faker Core" with brief descriptions of what the 4 items inside are for?
from faker.
FakerCore will likely be a new type/interface/thing in v9. (DAO for locales, mersenne and config, not fixed yet)
How about the following structure:
- API
- Faker
- SimpleFaker
- ...
- API Modules
- Animal
- ...
Alternatively, we could try the following
- API
- Faker
- SimpleFaker
- ...
<hr>
- Animal
- ...
from faker.
Alternatively, we could try the following
- API
- Faker
- SimpleFaker
- ...
<hr>
- Animal
- ...
I think that was the original idea.
from faker.
Related Issues (20)
- Speed up normalisation code HOT 8
- Release Checklist v9.0.0-alpha.0 HOT 1
- create icon on simple-icons HOT 32
- Localization lastName is not working HOT 2
- Phone numbers should support special numbers HOT 1
- Check capitisation of ex_MX/color/human
- Add v9.fakerjs.dev
- [Website] Change Navigation Behaviour HOT 4
- Generate Planet names HOT 9
- More varied product descriptions HOT 2
- Can't use Faker with k6 HOT 15
- Vehicle data is very US-centric HOT 1
- Improve specification of lorem module and definitions HOT 5
- Add plugin support for modules HOT 2
- Check whether complex objects should be frozen HOT 3
- Reevaluate word distribution
- Create Intl based tests for date definitions HOT 3
- Check whether the locale data should use locale aware sorting HOT 3
- 'lorem.words' missing for zh_CN HOT 5
- Use singular locale definition keys HOT 2
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 faker.